Concrete subclass of Thyra::LinearSolverBuilderBase for creating Thyra::LinearOpWithSolveFactoryBase objects and Thyra::PreconditionerFactoryBase objects on demand for various Trilinos linear solver and preconditioner packages. More...

#include <Stratimikos_LinearSolverBuilder_decl.hpp>

Inheritance diagram for Stratimikos::LinearSolverBuilder< Scalar >:

[legend]

Constructors/Initializers/Accessors
	LinearSolverBuilder (const std::string &paramsXmlFileName="", const std::string &extraParamsXmlString="", const std::string &paramsUsedXmlOutFileName="", const std::string &paramsXmlFileNameOption="linear-solver-params-file", const std::string &extraParamsXmlStringOption="extra-linear-solver-params", const std::string &paramsUsedXmlOutFileNameOption="linear-solver-params-used-file", const bool &replaceDuplicateFactories=true)
	Construct with default parameters. More...

	~LinearSolverBuilder ()

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, paramsXmlFileName)
	The name an XML file that will be read to get XML parameters (if not ""). More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, extraParamsXmlString)
	An XML string that will be used to update the parameters (if not ""). More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, paramsUsedXmlOutFileName)
	The name of an XML file that will be written (if not "") for the parameters actually used. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, paramsXmlFileNameOption)
	The name of the option that will be added the the commandline processor that will set `paramsXmlFileName()` . More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, extraParamsXmlStringOption)
	The name of the option that will be added the the commandline processor that will set `extraParamsXmlString()` . More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (std::string, paramsUsedXmlOutFileNameOption)
	The name of the option that will be added the the commandline processor that will set `paramsUsedXmlOutFileName()` . More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, replaceDuplicateFactories)
	Determines if duplicate registered factories are replaced or if an exception is thrown. More...

void	setLinearSolveStrategyFactory (const RCP< const AbstractFactory< Thyra::LinearOpWithSolveFactoryBase< Scalar > > > &solveStrategyFactory, const std::string &solveStrategyName, const bool makeDefault=false)
	Set a new linear solver strategy factory object. More...

void	setDefaultLinearSolveStrategyFactoryName (const std::string &solveStrategyName)
	Set the default linear solver factory name. More...

void	setPreconditioningStrategyFactory (const RCP< const AbstractFactory< Thyra::PreconditionerFactoryBase< Scalar > > > &precStrategyFactory, const std::string &precStrategyName, const bool makeDefault=false)
	Set a new preconditioner strategy factory object. More...

void	setDefaultPreconditioningStrategyFactoryName (const std::string &precStrategyName)
	Set the default linear solver factory name. More...

void	setupCLP (Teuchos::CommandLineProcessor *clp)
	Setup the command-line processor to read in the needed data to extra the parameters from. More...

void	readParameters (std::ostream *out)
	Force the parameters to be read from a file and/or an extra XML string. More...

void	writeParamsFile (const Thyra::LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const std::string &outputXmlFileName="") const
	Write the parameters list for a `LinearOpWithSolveFactoryBase` object to a file after the parameters are read in order to show defaults and create a new list for input the next time. More...

std::string	getLinearSolveStrategyName () const
	Get the name of the linear solver strategy that will be created on the next call to `this->createLinearSolverStrategy()`. More...

std::string	getPreconditionerStrategyName () const
	Get the name of the preconditioner strategy that will be created on the next call to `this->createPreconditioningStrategy()`. More...

Overridden from ParameterListAcceptor
void	setParameterList (RCP< ParameterList > const &paramList)

RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

RCP< const ParameterList >	getValidParameters () const

Overridden from LinearSolverBuilderBase.
RCP < Thyra::LinearOpWithSolveFactoryBase < Scalar > >	createLinearSolveStrategy (const std::string &linearSolveStrategyName) const

RCP < Thyra::PreconditionerFactoryBase < Scalar > >	createPreconditioningStrategy (const std::string &preconditioningStrategyName) const

Detailed Description

template<class Scalar = double>
class Stratimikos::LinearSolverBuilder< Scalar >

Concrete subclass of Thyra::LinearSolverBuilderBase for creating Thyra::LinearOpWithSolveFactoryBase objects and Thyra::PreconditionerFactoryBase objects on demand for various Trilinos linear solver and preconditioner packages.

For an example of how to use this class see simple_stratimikos_example.cpp.

A hierarchical list of all valid parameters is given below:

Examples:: MixedOrderPhysicsBasedPreconditioner.cpp, and simple_stratimikos_example.cpp.

Definition at line 87 of file Stratimikos_LinearSolverBuilder_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Stratimikos::LinearSolverBuilder< Scalar >::LinearSolverBuilder	(	const std::string &	paramsXmlFileName = `""`,
		const std::string &	extraParamsXmlString = `""`,
		const std::string &	paramsUsedXmlOutFileName = `""`,
		const std::string &	paramsXmlFileNameOption = `"linear-solver-params-file"`,
		const std::string &	extraParamsXmlStringOption = `"extra-linear-solver-params"`,
		const std::string &	paramsUsedXmlOutFileNameOption = `"linear-solver-params-used-file"`,
		const bool &	replaceDuplicateFactories = `true`
	)

Construct with default parameters.

Warning! Do not change the defaults by passing then into this constructor. Instead, use the member functions to set them after *this is constructed. This will help to avoid problems with updates to the ordering of the arguments.

Definition at line 68 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

Stratimikos::LinearSolverBuilder< Scalar >::~LinearSolverBuilder ( )

Definition at line 91 of file Stratimikos_LinearSolverBuilder_def.hpp.

Member Function Documentation

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		paramsXmlFileName
	)

The name an XML file that will be read to get XML parameters (if not "").

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		extraParamsXmlString
	)

An XML string that will be used to update the parameters (if not "").

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		paramsUsedXmlOutFileName
	)

The name of an XML file that will be written (if not "") for the parameters actually used.

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		paramsXmlFileNameOption
	)

The name of the option that will be added the the commandline processor that will set paramsXmlFileName() .

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		extraParamsXmlStringOption
	)

The name of the option that will be added the the commandline processor that will set extraParamsXmlString() .

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	std::string	,
		paramsUsedXmlOutFileNameOption
	)

The name of the option that will be added the the commandline processor that will set paramsUsedXmlOutFileName() .

template<class Scalar = double>

Stratimikos::LinearSolverBuilder< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	bool	,
		replaceDuplicateFactories
	)

Determines if duplicate registered factories are replaced or if an exception is thrown.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::setLinearSolveStrategyFactory	(	const RCP< const AbstractFactory< Thyra::LinearOpWithSolveFactoryBase< Scalar > > > &	solveStrategyFactory,
		const std::string &	solveStrategyName,
		const bool	makeDefault = `false`
	)

Set a new linear solver strategy factory object.

Definition at line 103 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::setDefaultLinearSolveStrategyFactoryName ( const std::string & solveStrategyName )

Set the default linear solver factory name.

Definition at line 129 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar = double>

void Stratimikos::LinearSolverBuilder< Scalar >::setPreconditioningStrategyFactory	(	const RCP< const AbstractFactory< Thyra::PreconditionerFactoryBase< Scalar > > > &	precStrategyFactory,
		const std::string &	precStrategyName,
		const bool	makeDefault = `false`
	)

Set a new preconditioner strategy factory object.

Definition at line 137 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::setDefaultPreconditioningStrategyFactoryName ( const std::string & precStrategyName )

Set the default linear solver factory name.

Definition at line 163 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::setupCLP ( Teuchos::CommandLineProcessor * clp )

Setup the command-line processor to read in the needed data to extra the parameters from.

Command-line options with names this->paramsXmlFileNameOption(), this->extraParamsXmlStringOption(), and this->paramsUsedXmlOutFileNameOption() will be set if they are not empty.

Then, when cpl->parse(...) is called, then the options set will be read into this->paramsXmlFileName(), this->extraParamsXmlString(), and this->paramsUsedXmlOutFileName().

After this function is called, this->readParameters() can be called to actually read in the parameters and fill the parameter list.

Examples:: simple_stratimikos_example.cpp.

Definition at line 171 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::readParameters ( std::ostream * out )

Force the parameters to be read from a file and/or an extra XML string.

First, if this->getParameterList().get()==NULL and new parameter list will be created.

Second, if this->paramsXmlFileName()!="" then the file this->paramsXmlFileName() will be read to get XML parameters append/update those already in the parameter list.

Third, if this->extraParamsXmlString()!="" then the XML string this->extraParamsXmlString() will be read and used to append/update the parameters already in the parameter list..

Postconditions:

this->getParameterList().get()!=NULL

Examples:: simple_stratimikos_example.cpp.

Definition at line 192 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::writeParamsFile	(	const Thyra::LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const std::string &	outputXmlFileName = `""`
	)		const

Write the parameters list for a LinearOpWithSolveFactoryBase object to a file after the parameters are read in order to show defaults and create a new list for input the next time.

If outputXmlFileName!="" then the parameter list with be written to the file outputXmlFileName in XML format. If outputXmlFileName=="", but this->paramsUsedXmlOutFileNameOption()!="" then the parameter list will be written to the file this->paramsUsedXmlOutFileNameOption(). If both outputXmlFileName=="" and this->paramsUsedXmlOutFileNameOption()=="" then no file is written.

Examples:: simple_stratimikos_example.cpp.

Definition at line 222 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

std::string Stratimikos::LinearSolverBuilder< Scalar >::getLinearSolveStrategyName ( ) const

Get the name of the linear solver strategy that will be created on the next call to this->createLinearSolverStrategy().

Definition at line 238 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

std::string Stratimikos::LinearSolverBuilder< Scalar >::getPreconditionerStrategyName ( ) const

Get the name of the preconditioner strategy that will be created on the next call to this->createPreconditioningStrategy().

Definition at line 248 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

void Stratimikos::LinearSolverBuilder< Scalar >::setParameterList ( RCP< ParameterList > const & paramList )

virtual

Implements Teuchos::ParameterListAcceptor.

Examples:: MixedOrderPhysicsBasedPreconditioner.cpp.

Definition at line 260 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Stratimikos::LinearSolverBuilder< Scalar >::getNonconstParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Examples:: simple_stratimikos_example.cpp.

Definition at line 274 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Stratimikos::LinearSolverBuilder< Scalar >::unsetParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 282 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Stratimikos::LinearSolverBuilder< Scalar >::getParameterList ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 292 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Stratimikos::LinearSolverBuilder< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Examples:: simple_stratimikos_example.cpp.

Definition at line 300 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > Stratimikos::LinearSolverBuilder< Scalar >::createLinearSolveStrategy ( const std::string & linearSolveStrategyName ) const

virtual

Implements Thyra::LinearSolverBuilderBase< Scalar >.

Examples:: simple_stratimikos_example.cpp.

Definition at line 388 of file Stratimikos_LinearSolverBuilder_def.hpp.

template<class Scalar >

RCP< Thyra::PreconditionerFactoryBase< Scalar > > Stratimikos::LinearSolverBuilder< Scalar >::createPreconditioningStrategy ( const std::string & preconditioningStrategyName ) const

virtual

Implements Thyra::LinearSolverBuilderBase< Scalar >.

Definition at line 449 of file Stratimikos_LinearSolverBuilder_def.hpp.

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

Constructors/Initializers/Accessors

Overridden from ParameterListAcceptor

Overridden from LinearSolverBuilderBase.

Detailed Description

template<class Scalar = double> class Stratimikos::LinearSolverBuilder< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

template<class Scalar = double>
class Stratimikos::LinearSolverBuilder< Scalar >