NumLib::ConvergenceCriterionPerComponent Class Reference

Detailed Description

Interface for applying a convergence criterion individually to each component of a multi-component solution or residual vector. Component here means sub-vector, not single scalar vector entry.

Definition at line 28 of file ConvergenceCriterionPerComponent.h.

#include <ConvergenceCriterionPerComponent.h>

Inheritance diagram for NumLib::ConvergenceCriterionPerComponent:

Collaboration diagram for NumLib::ConvergenceCriterionPerComponent:

Public Member Functions
	ConvergenceCriterionPerComponent (const MathLib::VecNormType norm_type)
virtual void	setDOFTable (NumLib::LocalToGlobalIndexMap const &dof_table, MeshLib::Mesh const &mesh)=0
	Sets the d.o.f. table used to extract data for a specific component.
Public Member Functions inherited from NumLib::ConvergenceCriterion
	ConvergenceCriterion (const MathLib::VecNormType norm_type)
virtual bool	hasDeltaXCheck () const =0
virtual bool	hasResidualCheck () const =0
virtual void	checkDeltaX (GlobalVector const &minus_delta_x, GlobalVector const &x)=0
virtual void	checkResidual (GlobalVector const &residual)=0
	Check if the residual satisfies the convergence criterion.
virtual void	preFirstIteration ()
virtual void	setNoFirstIteration ()
virtual void	reset ()
virtual bool	isSatisfied () const
	Tell if the convergence criterion is satisfied.
MathLib::VecNormType	getVectorNormType () const
virtual	~ConvergenceCriterion ()=default

Additional Inherited Members
Protected Attributes inherited from NumLib::ConvergenceCriterion
bool	_satisfied = true
bool	_is_first_iteration = true
const MathLib::VecNormType	_norm_type

Constructor & Destructor Documentation

ConvergenceCriterionPerComponent()

NumLib::ConvergenceCriterionPerComponent::ConvergenceCriterionPerComponent ( const MathLib::VecNormType norm_type )

inlineexplicit

Definition at line 31 of file ConvergenceCriterionPerComponent.h.

        : ConvergenceCriterion(norm_type)
    {
    }

Member Function Documentation

setDOFTable()

virtual void NumLib::ConvergenceCriterionPerComponent::setDOFTable ( NumLib::LocalToGlobalIndexMap const & dof_table, MeshLib::Mesh const & mesh )

pure virtual

Sets the d.o.f. table used to extract data for a specific component.

Implemented in NumLib::ConvergenceCriterionPerComponentDeltaX, and NumLib::ConvergenceCriterionPerComponentResidual.

---

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

• NumLib/ODESolver/ConvergenceCriterionPerComponent.h