SolverBase< VectorType >::StateCombiner Struct Reference

Detailed Description

template<typename VectorType = Vector<double>>
struct SolverBase< VectorType >::StateCombiner

A class whose operator() combines two states indicating whether we should continue iterating or stop, and returns a state that dominates. The rules are:

• If one of the two states indicates failure, return failure.
• Otherwise, if one of the two states indicates to continue iterating, then continue iterating.
• Otherwise, return success.

Definition at line 430 of file solver.h.

Public Types
using	result_type = SolverControl::State

Public Member Functions
SolverControl::State	operator() (const SolverControl::State state1, const SolverControl::State state2) const
template<typename Iterator >
SolverControl::State	operator() (const Iterator begin, const Iterator end) const

Member Typedef Documentation

result_type

template<typename VectorType = Vector<double>>

using SolverBase< VectorType >::StateCombiner::result_type = SolverControl::State

Definition at line 432 of file solver.h.

Member Function Documentation

operator()() [1/2]

template<typename VectorType = Vector<double>>

SolverControl::State SolverBase< VectorType >::StateCombiner::operator()	(	const SolverControl::State	state1,
		const SolverControl::State	state2
	)		const

operator()() [2/2]

template<typename VectorType = Vector<double>>

template<typename Iterator >

SolverControl::State SolverBase< VectorType >::StateCombiner::operator()	(	const Iterator	begin,
		const Iterator	end
	)		const

---

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

• include/deal.II/lac/solver.h