Equation solve foundational code
[Extended Operator/Vector interfaces]

Classes
struct	Thyra::SolveCriteria< Scalar >
	Simple struct that defines the requested solution criteria for a solve. More...
struct	Thyra::BlockSolveCriteria< Scalar >
	Simple struct that defines the requested solution criteria for a block solve. More...
class	Thyra::CatastrophicSolveFailure
	Exception type thrown on an catastrophic solve failure. More...
struct	Thyra::SolveStatus< Scalar >
	Simple struct for the return status from a solve. More...
Enumerations
enum	Thyra::ESolveTolType { Thyra::SOLVE_TOL_DEFAULT, Thyra::SOLVE_TOL_REL_RESIDUAL_NORM, Thyra::SOLVE_TOL_REL_SOLUTION_ERR_NORM }
	The type of the tolerance for the solve. More...
enum	Thyra::ESolveStatus { Thyra::SOLVE_STATUS_CONVERGED, Thyra::SOLVE_STATUS_UNCONVERGED, Thyra::SOLVE_STATUS_UNKNOWN }
	Solution status. More...
enum	Thyra::EPreconditionerInputType { Thyra::PRECONDITIONER_INPUT_TYPE_AS_OPERATOR, Thyra::PRECONDITIONER_INPUT_TYPE_AS_MATRIX }
	Enum defining the status of a preconditioner object. More...
Functions
template<class Scalar>
void	Thyra::accumulateSolveStatus (const SolveCriteria< Scalar > &overallSolveCriteria, const SolveStatus< Scalar > &solveStatus, SolveStatus< Scalar > *overallSolveStatus)
	Accumulate solve status objects for solving a block of RHSs is smaller sub-blocks.

---

Enumeration Type Documentation

enum ESolveTolType

The type of the tolerance for the solve. Enumeration values: SOLVE_TOL_DEFAULT  Use some default solve criteria. SOLVE_TOL_REL_RESIDUAL_NORM  Enforce the tolerance on the relative natural norm in the residual vector. SOLVE_TOL_REL_SOLUTION_ERR_NORM  Enforce the tolerance on the relative natural norm in the error in the solution vector. Definition at line 45 of file Thyra_SolveSupportTypes.hpp.

enum ESolveStatus

Solution status. Enumeration values: SOLVE_STATUS_CONVERGED  The requested solution criteria has likely been achieved. SOLVE_STATUS_UNCONVERGED  The requested solution criteria has likely not been achieved. SOLVE_STATUS_UNKNOWN  The final solution status is unknown but he solve did not totally fail. Definition at line 136 of file Thyra_SolveSupportTypes.hpp.

enum EPreconditionerInputType

Enum defining the status of a preconditioner object. Enumeration values: PRECONDITIONER_INPUT_TYPE_AS_OPERATOR  The input preconditioner should just be applied as an operator. PRECONDITIONER_INPUT_TYPE_AS_MATRIX  The input preconditioner should viewed as a matrix to be factored then backsolved as a preconditioner. Definition at line 202 of file Thyra_SolveSupportTypes.hpp.

---

Function Documentation

template<class Scalar> void accumulateSolveStatus (  const SolveCriteria< Scalar > &  overallSolveCriteria, const SolveStatus< Scalar > &  solveStatus, SolveStatus< Scalar > *  overallSolveStatus )

Accumulate solve status objects for solving a block of RHSs is smaller sub-blocks. Parameters: overallSolveCriteria  [in] The overall solve criteria for the overall blocks. solveStatus  [in] The solve status for a sub-block (or a single RHS) overallSolveStatus  [in/out] The accumulated solve status for all the sub-blocks of RHS. On the first call, set overallSolveStatus->solveStatus = SOLVE_STATUS_CONVERGED and overallSolveStatus->iterations = 0! Definition at line 222 of file Thyra_SolveSupportTypes.hpp.

---