SOFA API  83276a98
Open source framework for multi-physics simuation
sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter Struct Reference

#include <NewtonRaphsonConvergenceMeasure.h>

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

Public Attributes

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

Public Member Functions

 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 bool hasConverged () const =0
 
virtual NewtonStatus status () const =0
 
virtual std::string writeWhenConverged () const =0
 
virtual std::string writeWhenNotConverged () const
 
virtual std::string_view measureName () const =0
 

Attribute details

◆ param

SReal sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter::param

◆ squaredParam

SReal sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter::squaredParam

Constructor details

◆ NewtonRaphsonConvergenceMeasureWithSquaredParameter()

sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter::NewtonRaphsonConvergenceMeasureWithSquaredParameter ( SReal  p)
inlineexplicit

Function details

◆ isMeasured()

bool sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter::isMeasured ( ) const
inlineoverridevirtual

◆ setParam()

void sofa::component::odesolver::backward::NewtonRaphsonConvergenceMeasureWithSquaredParameter::setParam ( const SReal  p)
inline