Equation solve foundational code

Classes
struct	Thyra::SolveMeasureType
	Solve tolerance type. More...
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::ESolveMeasureNormType {   Thyra::SOLVE_MEASURE_ONE, Thyra::SOLVE_MEASURE_NORM_RESIDUAL, Thyra::SOLVE_MEASURE_NORM_SOLUTION, Thyra::SOLVE_MEASURE_NORM_INIT_RESIDUAL,   Thyra::SOLVE_MEASURE_NORM_RHS }
	Type of solve measure norm. More...
enum	Thyra::ESolveStatus { Thyra::SOLVE_STATUS_CONVERGED, Thyra::SOLVE_STATUS_UNCONVERGED, Thyra::SOLVE_STATUS_UNKNOWN }
	Solution status. More...
enum	Thyra::ESupportSolveUse { Thyra::SUPPORT_SOLVE_UNSPECIFIED, Thyra::SUPPORT_SOLVE_FORWARD_ONLY, Thyra::SUPPORT_SOLVE_TRANSPOSE_ONLY, Thyra::SUPPORT_SOLVE_FORWARD_AND_TRANSPOSE }
	Enum that specifies how a LinearOpWithSolveBase object will be used for solves after it is constructed. 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 Thyra::ESolveMeasureNormType

Type of solve measure norm.

For reference we refer to solving a single linear system A*x=b.

Enumerator:

SOLVE_MEASURE_ONE	No solve measure (i.e. same as 1.0).
SOLVE_MEASURE_NORM_RESIDUAL	Norm of the current residual vector (i.e. ||A*x-b||).
SOLVE_MEASURE_NORM_SOLUTION	Norm of the current solution vector (i.e. ||x||).
SOLVE_MEASURE_NORM_INIT_RESIDUAL	Norm of the initial residual vector given a non-zero guess (i.e. ||A*xo-b||).
SOLVE_MEASURE_NORM_RHS	Norm of the Right-hand side (i.e. ||b||).

Definition at line 49 of file Thyra_SolveSupportTypes.hpp.

enum Thyra::ESolveStatus

Solution status.

Enumerator:

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 189 of file Thyra_SolveSupportTypes.hpp.

enum Thyra::ESupportSolveUse

Enum that specifies how a LinearOpWithSolveBase object will be used for solves after it is constructed.

Enumerator:

SUPPORT_SOLVE_UNSPECIFIED	How the output LOWSB object will be useded for solves in unspecified.
SUPPORT_SOLVE_FORWARD_ONLY	The output LOWSB object will only be used for forward solves.
SUPPORT_SOLVE_TRANSPOSE_ONLY	The output LOWSB object will only be used for transpose solves.
SUPPORT_SOLVE_FORWARD_AND_TRANSPOSE	The output LOWSB object will used for forward and transpose solves.

Definition at line 276 of file Thyra_SolveSupportTypes.hpp.

enum Thyra::EPreconditionerInputType

Enum defining the status of a preconditioner object.

Enumerator:

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 287 of file Thyra_SolveSupportTypes.hpp.

---

Function Documentation

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.

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 307 of file Thyra_SolveSupportTypes.hpp.

---