Piro Namespace Reference

Main namespace of the Piro package. More...

Namespaces
namespace	Epetra
	Namespace that holds the definitions specific to Epetra.

Classes
class	CustomLBFGSSecant
class	InvertMassMatrixDecorator
class	LOCASolver
	Thyra-based Model Evaluator for LOCA solves. More...
class	MatrixFreeDecorator
	Decorator class that creates a Jacobian (W) operator using matrix-free directional derivatives. More...
class	MatrixFreeLinearOp
	This class implements a matrix-free Jacobian linear operator based on finite difference. More...
class	NOXSolver
	Thyra-based Model Evaluator for NOX solves. More...
class	ObserverBase
class	ObserverToLOCASaveDataStrategyAdapter
class	ObserverToTempusIntegrationObserverAdapter
class	ProductModelEvaluator
	Product Model Evaluator Model Evaluator that supports only one parameter which is a product vector. The evaluator has an internal evaluator that treats this product parameter as multiple parameters. More...
class	Provider
	Handle for auxiliary object factories. More...
class	ProviderBase
	Generic abstract base class for an auxiliary object factory. More...
class	ROL_ObserverBase
class	RolOutputBuffer
class	SolutionObserverBase
class	SolverFactory
	Factory for creating Thyra-based Piro solvers. More...
class	SteadyStateSolver
	Thyra-based abstract Model Evaluator for steady-states solves. More...
class	TempusIntegrator
	Thyra-based Model Evaluator for Tempus solves using Tempus. More...
class	TempusSolver
	Thyra-based Model Evaluator for Tempus solves. More...
class	TempusSolverForwardOnly
	Thyra-based Model Evaluator for Tempus solves. More...
class	TempusStepControlFactory
class	TempusStepperFactory
class	ThyraProductME_Constraint_SimOpt
	ROL interface wrapper for Sacado SimOpt Constraint. More...
class	ThyraProductME_Objective_SimOpt
class	ThyraProductME_ROL_DynamicConstraint
class	ThyraProductME_ROL_DynamicObjective
	ThyraProductME_ROL_DynamicObjective. More...
class	ThyraProductME_TempusFinalObjective
class	TransientDecorator
class	TransientSolver
	Thyra-based Model Evaluator for Tempus solves using Tempus. More...
class	TrapezoidDecorator
class	TrapezoidRuleSolver

Enumerations
enum	SENS_METHOD { NONE , FORWARD , ADJOINT }

Functions
template Teuchos::RCP< LOCASolver< double > >	observedLocaSolver (const Teuchos::RCP< Teuchos::ParameterList > &appParams, const Teuchos::RCP< Thyra::ModelEvaluator< double > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< double > > &adjointModel, const Teuchos::RCP< Piro::ObserverBase< double > > &observer)
template<typename Scalar >
Teuchos::RCP< LOCASolver< Scalar > >	observedLocaSolver (const Teuchos::RCP< Teuchos::ParameterList > &piroParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjointModel=Teuchos::null, const Teuchos::RCP< Piro::ObserverBase< Scalar > > &observer=Teuchos::null)
template<typename Real >
Teuchos::RCP< Piro::ProductModelEvaluator< Real > >	getNonconstProductModelEvaluator (Teuchos::RCP< Thyra::ModelEvaluator< Real > > model)
template<typename Real >
Teuchos::RCP< const Piro::ProductModelEvaluator< Real > >	getProductModelEvaluator (const Teuchos::RCP< const Thyra::ModelEvaluator< Real > > model)
template<typename Real >
Teuchos::RCP< const Piro::ProductModelEvaluator< Real > >	getProductModelEvaluator (const Teuchos::RCP< Thyra::ModelEvaluatorDefaultBase< Real > > model)
Teuchos::RCP< Teuchos::ParameterList >	extractStratimikosParams (const Teuchos::RCP< Teuchos::ParameterList > &piroParams)
	Extracts the Stratimikos sublist from the Piro Solver parameter list.
void	renamePreconditionerParamList (const Teuchos::RCP< Teuchos::ParameterList > &stratParams, const std::string &oldname, const std::string &newname)
	Rename the preconditioner and parameter list.
template<typename Scalar >
Teuchos::RCP< TempusSolver< Scalar > >	tempusSolver (const Teuchos::RCP< Teuchos::ParameterList > &appParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjointModel=Teuchos::null, const Teuchos::RCP< ObserverBase< Scalar > > &piroObserver=Teuchos::null)
	Non-member constructor function.
template<typename Scalar >
Teuchos::RCP< TempusSolverForwardOnly< Scalar > >	tempusSolverForwardOnly (const Teuchos::RCP< Teuchos::ParameterList > &appParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &in_model, const Teuchos::RCP< ObserverBase< Scalar > > &piroObserver)
	Non-member constructor function.
template<typename Real >
Teuchos::RCP< Thyra::VectorBase< Real > >	compute_u_dot (Teuchos::RCP< const Thyra::VectorBase< Real > > u_new, Teuchos::RCP< const Thyra::VectorBase< Real > > u_old, Real dt)
Teuchos::RCP< const Teuchos::ParameterList >	getValidPiroParameters ()
std::string	Piro_Version ()
Top-level Thyra analysis driver
int	PerformAnalysis (Thyra::ModelEvaluatorDefaultBase< double > &piroModel, Teuchos::ParameterList &analysisParams, Teuchos::RCP< Thyra::VectorBase< double > > &result, Teuchos::RCP< ROL_ObserverBase< double > > observer=Teuchos::null)
	Performs analysis of a solved model.
int	PerformROLSteadyAnalysis (Thyra::ModelEvaluatorDefaultBase< double > &piroModel, Teuchos::ParameterList &rolParams, Teuchos::RCP< Thyra::VectorBase< double > > &p, Teuchos::RCP< ROL_ObserverBase< double > > observer=Teuchos::null)
	Performs analysis of a steady state solved model using ROL.
int	PerformROLTransientAnalysis (Thyra::ModelEvaluatorDefaultBase< double > &piroModel, Teuchos::ParameterList &rolParams, Teuchos::RCP< Thyra::VectorBase< double > > &p, Teuchos::RCP< ROL_ObserverBase< double > > observer=Teuchos::null)
	Performs analysis of a transient solved model using ROL.
int	PerformROLAnalysis (Thyra::ModelEvaluatorDefaultBase< double > &piroModel, Teuchos::ParameterList &rolParams, Teuchos::RCP< Thyra::VectorBase< double > > &p, Teuchos::RCP< ROL_ObserverBase< double > > observer=Teuchos::null)
	Performs analysis of a solved model using ROL.
Analysis parameter list validation
Teuchos::RCP< const Teuchos::ParameterList >	getValidPiroAnalysisParameters ()
Teuchos::RCP< const Teuchos::ParameterList >	getValidPiroAnalysisROLParameters (int num_parameters)
Top-level Thyra solve drivers
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response)
	Evaluates the solved model and returns the first response.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response)
	Evaluates the solved model and returns the specified response.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response, Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > &sensitivity)
	Evaluates the solved model and returns the specified response and sensitivity.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &sensitivities)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > &directions, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &reducedHessian)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolve (const Thyra::ResponseOnlyModelEvaluatorBase< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > &directions, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &reducedHessian)
	Evaluates the solved model and returns specified responses and sensitivities.
Other Thyra solve drivers
The drivers do not statically check that the model is of the response-only variety.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response)
	Evaluates the solved model and returns the first response.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response)
	Evaluates the solved model and returns the specified response.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::RCP< Thyra::VectorBase< Scalar > > &response, Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > &sensitivity)
	Evaluates the solved model and returns the specified response and sensitivity.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &sensitivities)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::RCP< SolutionObserverBase< Scalar, const Thyra::VectorBase< Scalar > > > observer)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > &directions, Teuchos::Array< Teuchos::Array< Teuchos::RCP< Thyra::MultiVectorBase< Scalar > > > > &reducedHessian)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > &directions, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &reducedHessian)
	Evaluates the solved model and returns specified responses and sensitivities.
template<typename Scalar >
void	PerformSolveBase (const Thyra::ModelEvaluator< Scalar > &piroModel, Teuchos::ParameterList &solveParams, Teuchos::Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &responses, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &sensitivities, Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > &directions, Teuchos::Array< Teuchos::Array< Teuchos::RCP< const Thyra::MultiVectorBase< Scalar > > > > &reducedHessian, Teuchos::RCP< SolutionObserverBase< Scalar, const Thyra::VectorBase< Scalar > > > observer)
	Evaluates the solved model and returns specified responses and sensitivities.

Detailed Description

Main namespace of the Piro package.

All Thyra-based definitions are directly located in the Piro namespace. Definitions that are specific to Epetra are in the enclosed Epetra namespace.