Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
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.
 
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.
 

Private Member Functions

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

Detailed Description

Factory for generating stochastic Galerkin preconditioners.

Definition at line 57 of file Stokhos_SGPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ SGPreconditionerFactory() [1/2]

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

Constructor.

Definition at line 54 of file Stokhos_SGPreconditionerFactory.cpp.

◆ ~SGPreconditionerFactory()

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

Destructor.

Definition at line 65 of file Stokhos_SGPreconditionerFactory.hpp.

◆ SGPreconditionerFactory() [2/2]

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

Private to prohibit copying.

Member Function Documentation

◆ isPrecSupported()

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

Return whether a preconditioner will be supported.

Definition at line 62 of file Stokhos_SGPreconditionerFactory.cpp.

◆ 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.

Definition at line 69 of file Stokhos_SGPreconditionerFactory.cpp.

◆ buildMeanPreconditionerFactory()

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

Build preconditioner factory for mean.

Definition at line 155 of file Stokhos_SGPreconditionerFactory.cpp.

◆ operator=()

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

Private to prohibit copying.

Member Data Documentation

◆ params

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

Preconditioner parameters.

Definition at line 96 of file Stokhos_SGPreconditionerFactory.hpp.

◆ prec_method

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

Preconditioner method.

Definition at line 99 of file Stokhos_SGPreconditionerFactory.hpp.


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