EnergyConvCheck Class Reference

Energy Convergence Check. More...

Inheritance diagram for EnergyConvCheck:

Public Member Functions
double	avg_rate () const
std::string	config_string () const
double	defect () const
	returns the current defect More...
	EnergyConvCheck (int Maximum_Steps, double Minimum_Defect, double Relative_Reduction)
	EnergyConvCheck (int Maximum_Steps, double Minimum_Defect, double Relative_Reduction, bool Verbosity)
	EnergyConvCheck (int Maximum_Steps, double Minimum_Defect, double Relative_Reduction, bool Verbositysupress_unsuccessful_return, bool unnamed)
bool	iteration_ended ()
double	reduction () const
	returns the current relative reduction More...
void	set_linear_operator (SmartPtr< ILinearOperator > unnamed)
int	step () const
	returns the current number of steps More...

Detailed Description

Energy Convergence Check.

Note

default specialization is EnergyConvCheckCPU1

See also

ug::EnergyConvCheck

Constructor & Destructor Documentation

EnergyConvCheck() [1/3]

EnergyConvCheck	(	int	Maximum_Steps,
		double	Minimum_Defect,
		double	Relative_Reduction,
		bool	Verbosity
	)

Parameters

[in]	Maximum_Steps
[in]	Minimum_Defect
[in]	Relative_Reduction
[in]	Verbosity

EnergyConvCheck() [2/3]

EnergyConvCheck	(	int	Maximum_Steps,
		double	Minimum_Defect,
		double	Relative_Reduction,
		bool	Verbositysupress_unsuccessful_return,
		bool	unnamed
	)

Parameters

[in]	Maximum_Steps
[in]	Minimum_Defect
[in]	Relative_Reduction
[in]	Verbositysupress_unsuccessful_return
[in]	unnamed

EnergyConvCheck() [3/3]

EnergyConvCheck	(	int	Maximum_Steps,
		double	Minimum_Defect,
		double	Relative_Reduction
	)

Parameters

[in]	Maximum_Steps
[in]	Minimum_Defect
[in]	Relative_Reduction

Member Function Documentation

avg_rate()

double avg_rate ( ) const

inlineinherited

References IConvergenceCheck< TVector >::avg_rate().

config_string()

std::string config_string ( ) const

inlineinherited

References IConvergenceCheck< TVector >::config_string().

defect()

double defect ( ) const

inlineinherited

returns the current defect

Returns

defect

References IConvergenceCheck< TVector >::defect().

iteration_ended()

bool iteration_ended ( )

inlineinherited

References IConvergenceCheck< TVector >::iteration_ended().

reduction()

double reduction ( ) const

inlineinherited

returns the current relative reduction

Returns

reduction

References IConvergenceCheck< TVector >::reduction().

set_linear_operator()

void set_linear_operator ( SmartPtr< ILinearOperator >  unnamed )

inline

Parameters

[in]

unnamed

References EnergyConvCheck< class >::set_linear_operator().

step()

int step ( ) const

inlineinherited

returns the current number of steps

Returns

step

References IConvergenceCheck< TVector >::step().