SOFA API  cb3b2882
Open source framework for multi-physics simuation
sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure Class Reference

#include <RelativeSuccessiveConvergenceMeasure.h>

Inheritance diagram for sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure:

Public Attributes

SReal squaredResidualNorm = 0
 
SReal previousSquaredResidualNorm = 0
 
- Public Attributes inherited from sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter
SReal param
 
SReal squaredParam
 
- Public Attributes inherited from sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasure
unsigned int newtonIterationCount = 0
 

Public Member Functions

 RelativeSuccessiveConvergenceMeasure (SReal relativeSuccessiveStoppingThreshold)
 
bool hasConverged () const override
 
NewtonStatus status () const override
 
std::string writeWhenConverged () const override
 
std::string_view measureName () const override
 
- Public Member Functions inherited from sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter
 NewtonRaphsonConvergenceMeasureWithSquaredParameter (SReal p)
 
void setParam (const SReal p)
 
bool isMeasured () const override
 
- Public Member Functions inherited from sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasure
virtual ~NewtonRaphsonConvergenceMeasure ()=default
 
virtual std::string writeWhenNotConverged () const
 

Attribute details

◆ previousSquaredResidualNorm

SReal sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::previousSquaredResidualNorm = 0

◆ squaredResidualNorm

SReal sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::squaredResidualNorm = 0

Constructor details

◆ RelativeSuccessiveConvergenceMeasure()

sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::RelativeSuccessiveConvergenceMeasure ( SReal  relativeSuccessiveStoppingThreshold)
inlineexplicit

Function details

◆ hasConverged()

bool sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::hasConverged ( ) const
inlineoverridevirtual

◆ measureName()

std::string_view sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::measureName ( ) const
inlineoverridevirtual

◆ status()

NewtonStatus sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::status ( ) const
inlineoverridevirtual

◆ writeWhenConverged()

std::string sofa::component::odesolver::backward::RelativeSuccessiveConvergenceMeasure::writeWhenConverged ( ) const
inlineoverridevirtual