Piro::SolverFactory Class Reference

Factory for creating Thyra-based Piro solvers. More...

#include <Piro_SolverFactory.hpp>

Public Member Functions
template<typename Scalar , typename LocalOrdinal = int, typename GlobalOrdinal = LocalOrdinal, typename Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP < Thyra::ResponseOnlyModelEvaluatorBase < Scalar > >	createSolver (const Teuchos::RCP< Teuchos::ParameterList > &piroParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::AdaptiveSolutionManager > &solMgr, const Teuchos::RCP< Piro::ObserverBase< Scalar > > &observer=Teuchos::null)
	Create a solved model. More...
template<typename Scalar , typename LocalOrdinal = int, typename GlobalOrdinal = LocalOrdinal, typename Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP < Thyra::ResponseOnlyModelEvaluatorBase < Scalar > >	createSolver (const Teuchos::RCP< Teuchos::ParameterList > &piroParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Piro::ObserverBase< Scalar > > &observer=Teuchos::null)

Detailed Description

Factory for creating Thyra-based Piro solvers.

Piro::Epetra::SolverFactory is the counterpart for Epetra-based models.

Member Function Documentation

template<typename Scalar , typename LocalOrdinal = int, typename GlobalOrdinal = LocalOrdinal, typename Node = KokkosClassic::DefaultNode::DefaultNodeType>

Teuchos::RCP<Thyra::ResponseOnlyModelEvaluatorBase<Scalar> > Piro::SolverFactory::createSolver	(	const Teuchos::RCP< Teuchos::ParameterList > &	piroParams,
		const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &	model,
		const Teuchos::RCP< Thyra::AdaptiveSolutionManager > &	solMgr,
		const Teuchos::RCP< Piro::ObserverBase< Scalar > > &	observer = Teuchos::null
	)

Create a solved model.

The type of Piro solver to instantiate is determined by the value of the string entry labeled "Solver Type" and located at the top level of parameter list piroParams.

Currently, the following solver types are available (each accompanied by the corresponding token value):

• Piro::NOXSolver ("NOX")
• Piro::LOCASolver ("LOCA")
• Piro::RythmosSolver ("Rythmos")
• Piro::VelocityVerletSolver ("Velocity Verlet")
• Piro::TrapezoidRuleSolver ("Trapezoid Rule")

For Epetra-based models, additional options are available in Piro::Epetra::SolverFactory.

---

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

• Piro_SolverFactory.hpp