Non-member helper functions for Thyra::LinearOpWithSolveFactoryBase

Functions
template<class Scalar>
bool	Thyra::isCompatible (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const LinearOpBase< Scalar > &fwdOp)
	Return if the forward operator is a compatible source for a LOWSFB object.
template<class Scalar>
Teuchos::RCP< LinearOpWithSolveBase< Scalar > >	Thyra::linearOpWithSolve (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Create and initialize a LinearOpWithSolveBase object from a LinearOpBase object using a LinearOpWithSolveFactoryBase strategy object.
template<class Scalar>
Teuchos::RCP< LinearOpBase< Scalar > >	Thyra::inverse (const LinearOpWithSolveFactoryBase< Scalar > &LOWSF, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED, const SolveCriteria< Scalar > *fwdSolveCriteria=NULL, const EThrowOnSolveFailure throwOnFwdSolveFailure=THROW_ON_SOLVE_FAILURE, const SolveCriteria< Scalar > *adjSolveCriteria=NULL, const EThrowOnSolveFailure throwOnAdjSolveFailure=THROW_ON_SOLVE_FAILURE)
	Form a const implicit inverse operator <tt>M = inv(A) given a factory.
template<class Scalar>
void	Thyra::initializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a pre-created LOWSB object given a forward operator.
template<class Scalar>
void	Thyra::initializeAndReuseOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, LinearOpWithSolveBase< Scalar > *Op)
	Reinitialize a pre-created LOWSB object given a forward operator, reusing a much as possible from the prior LOWSB object.
template<class Scalar>
void	Thyra::initializePreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const Teuchos::RCP< const PreconditionerBase< Scalar > > &prec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a preconditioned LOWSB object given an external preconditioner.
template<class Scalar>
void	Thyra::initializeApproxPreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const Teuchos::RCP< const LinearOpBase< Scalar > > &approxFwdOp, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a preconditioned LOWSB object given an external operator to be used to generate the preconditioner internally.
template<class Scalar>
void	Thyra::uninitializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, LinearOpWithSolveBase< Scalar > *Op, Teuchos::RCP< const LinearOpBase< Scalar > > *fwdOp=NULL, Teuchos::RCP< const PreconditionerBase< Scalar > > *prec=NULL, Teuchos::RCP< const LinearOpBase< Scalar > > *approxFwdOp=NULL, ESupportSolveUse *supportSolveUse=NULL)
	Uninitialized a pre-created LOWSB object, returning input objects used to initialize it.

---

Function Documentation

template<class Scalar>

bool Thyra::isCompatible	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const LinearOpBase< Scalar > &	fwdOp
	)

Return if the forward operator is a compatible source for a LOWSFB object.

Examples:

silly1DFFT_serial.cpp.

Definition at line 47 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

Teuchos::RCP<LinearOpWithSolveBase<Scalar> > Thyra::linearOpWithSolve	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const ESupportSolveUse	supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
	)

Create and initialize a LinearOpWithSolveBase object from a LinearOpBase object using a LinearOpWithSolveFactoryBase strategy object.

Examples:

Thyra_LinearOpWithSolveFactoryExamples.hpp.

Definition at line 62 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

Teuchos::RCP<LinearOpBase<Scalar> > Thyra::inverse	(	const LinearOpWithSolveFactoryBase< Scalar > &	LOWSF,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const ESupportSolveUse	supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED,
		const SolveCriteria< Scalar > *	fwdSolveCriteria = NULL,
		const EThrowOnSolveFailure	throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
		const SolveCriteria< Scalar > *	adjSolveCriteria = NULL,
		const EThrowOnSolveFailure	throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
	)

Form a const implicit inverse operator <tt>M = inv(A) given a factory.

Examples:

silly1DFFT_serial.cpp.

Definition at line 81 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

void Thyra::initializeOp	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
	)

Initialize a pre-created LOWSB object given a forward operator.

Definition at line 104 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

void Thyra::initializeAndReuseOp	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		LinearOpWithSolveBase< Scalar > *	Op
	)

Reinitialize a pre-created LOWSB object given a forward operator, reusing a much as possible from the prior LOWSB object.

Definition at line 121 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

void Thyra::initializePreconditionedOp	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const Teuchos::RCP< const PreconditionerBase< Scalar > > &	prec,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
	)

Initialize a preconditioned LOWSB object given an external preconditioner.

Definition at line 137 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

void Thyra::initializeApproxPreconditionedOp	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const Teuchos::RCP< const LinearOpBase< Scalar > > &	approxFwdOp,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
	)

Initialize a preconditioned LOWSB object given an external operator to be used to generate the preconditioner internally.

Definition at line 157 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

template<class Scalar>

void Thyra::uninitializeOp	(	const LinearOpWithSolveFactoryBase< Scalar > &	lowsFactory,
		LinearOpWithSolveBase< Scalar > *	Op,
		Teuchos::RCP< const LinearOpBase< Scalar > > *	fwdOp = NULL,
		Teuchos::RCP< const PreconditionerBase< Scalar > > *	prec = NULL,
		Teuchos::RCP< const LinearOpBase< Scalar > > *	approxFwdOp = NULL,
		ESupportSolveUse *	supportSolveUse = NULL
	)

Uninitialized a pre-created LOWSB object, returning input objects used to initialize it.

Definition at line 177 of file Thyra_LinearOpWithSolveFactoryHelpers.hpp.

---