Thyra-based Model Evaluator for Tempus solves. More...
#include <Piro_TempusSolver.hpp>
Inheritance diagram for Piro::TempusSolver< Scalar >:
Collaboration diagram for Piro::TempusSolver< Scalar >:
Public Member Functions | |
Constructors/initializers | |
| 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< Piro::ObserverBase< Scalar > > &piroObserver=Teuchos::null) | |
Initializes the internals, though the object is a blank slate. To initialize it call initialize | |
| TempusSolver (const Teuchos::RCP< Piro::TempusIntegrator< Scalar > > &stateIntegrator, const Teuchos::RCP< Tempus::Stepper< Scalar > > &stateStepper, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &timeStepSolver, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, Scalar finalTime, const std::string sens_method_string="None", const int sens_param_index=-1, const int response_fn_index=-1, Teuchos::EVerbosityLevel verbosityLevel=Teuchos::VERB_DEFAULT) | |
| Initialize using prebuilt objects. | |
| TempusSolver (const Teuchos::RCP< Piro::TempusIntegrator< Scalar > > &stateIntegrator, const Teuchos::RCP< Tempus::Stepper< Scalar > > &stateStepper, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &timeStepSolver, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, Scalar initialTime, Scalar finalTime, const std::string sens_method_string="None", const int sens_param_index=-1, const int response_fn_index=-1, Teuchos::EVerbosityLevel verbosityLevel=Teuchos::VERB_DEFAULT) | |
| Initialize using prebuilt objects - supplying initial time value. | |
| void | initialize (const Teuchos::RCP< Teuchos::ParameterList > &appParams, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &adjointModel) |
| void | addStepperFactory (const std::string &stepperName, const Teuchos::RCP< Piro::TempusStepperFactory< Scalar > > &stepperFactories) |
| void | addStepControlFactory (const std::string &stepControlName, const Teuchos::RCP< Piro::TempusStepControlFactory< Scalar > > &step_control_strategy) |
| void | setStartTime (const Scalar start_time) |
| Set start time for time-integration. | |
| Scalar | getStartTime () const |
| Get start time for time-integration. | |
| void | setFinalTime (const Scalar final_time) |
| Set final time for time-integration. | |
| Scalar | getFinalTime () const |
| Get final time for time-integration. | |
| void | setInitTimeStep (const Scalar init_time_step) |
| Set initial time step for time-integration. | |
| Scalar | getInitTimeStep () const |
| Get initial time step for time-integration. | |
| void | setInitialState (Scalar t0, Teuchos::RCP< Thyra::VectorBase< Scalar > > x0, Teuchos::RCP< Thyra::VectorBase< Scalar > > xdot0=Teuchos::null, Teuchos::RCP< Thyra::VectorBase< Scalar > > xdotdot0=Teuchos::null) |
| Set initial time, initial solution, velocity and acceleration. | |
| void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess=Teuchos::null) |
| Set initial guess for Newton method. | |
| Teuchos::RCP< Tempus::SolutionHistory< Scalar > > | getSolutionHistory () const |
| Return RCP to Tempus::SolutionHistory. | |
| Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const |
| Return Thyra nonlinear solver underlying Tempus::Stepper object | |
| Tempus::Status | getTempusIntegratorStatus () const |
| Teuchos::RCP< const Piro::TempusIntegrator< Scalar > > | getPiroTempusIntegrator () const |
| Teuchos::RCP< Piro::TempusIntegrator< Scalar > > | getNonconstPiroTempusIntegrator () const |
| Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > | getSubModel () |
| Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > | getAdjointSubModel () |
 Public Member Functions inherited from Piro::TransientSolver< Scalar > | |
| TransientSolver (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< Teuchos::ParameterList > &appParams, const Teuchos::RCP< Piro::ObserverBase< Scalar > > &piroObserver=Teuchos::null) | |
| TransientSolver (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model, const int sens_param_index=-1, const int response_fn_index=-1) | |
| Thyra::ModelEvaluatorBase::InArgs< Scalar > | getNominalValues () const |
| Thyra::ModelEvaluatorBase::InArgs< Scalar > | createInArgs () const |
| Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_p_space (int l) const |
| Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_g_space (int j) const |
| const Thyra::ModelEvaluator< Scalar > & | getModel () const |
| int | num_p () const |
| int | num_g () const |
| SENS_METHOD | getSensitivityMethod () |
| void | setSensitivityMethod (const std::string &sensitivity_method_string) |
| void | setPiroTempusIntegrator (Teuchos::RCP< const Piro::TempusIntegrator< Scalar > > piroTempusIntegrator) |
| void | resetSensitivityParamIndex (const int sens_param_index) |
| void | resetResponseFnIndex (const int response_fn_index) |
Additional Inherited Members | |
| Protected Member Functions inherited from Piro::TransientSolver< Scalar > | |
| void | evalConvergedModelResponsesAndSensitivities (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &modelInArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const |
Detailed Description
template<typename Scalar>
class Piro::TempusSolver< Scalar >
class Piro::TempusSolver< Scalar >
Thyra-based Model Evaluator for Tempus solves.
Constructor & Destructor Documentation
◆ TempusSolver()
template<typename Scalar >
| Piro::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< Piro::ObserverBase< Scalar > > & | piroObserver = Teuchos::null |
||
| ) |
Initializes the internals, though the object is a blank slate. To initialize it call initialize
Initialize with internally built objects according to the given parameter list.
The documentation for this class was generated from the following file:
- Piro_TempusSolver.hpp
