Opm::NewtonMethodParams< Scalar > Struct Template Reference

Struct holding the parameters for NewtonMethod. More...

#include <newtonmethodparams.hpp>

Public Member Functions
void	read ()
	Reads the parameter values from the parameter system. More...

Static Public Member Functions
static void	registerParameters ()
	Registers the parameters in parameter system. More...

Public Attributes
bool	verbose_
bool	writeConvergence_
int	targetIterations_
	Optimal number of iterations we want to achieve. More...
int	maxIterations_
	Maximum number of iterations we do before giving up. More...
Scalar	tolerance_
Scalar	maxError_

Detailed Description

template<class Scalar>
struct Opm::NewtonMethodParams< Scalar >

Struct holding the parameters for NewtonMethod.

Member Function Documentation

read()

template<class Scalar >

void Opm::NewtonMethodParams< Scalar >::read

(

)

Reads the parameter values from the parameter system.

registerParameters()

template<class Scalar >

static void Opm::NewtonMethodParams< Scalar >::registerParameters ( )

static

Registers the parameters in parameter system.

Referenced by Opm::NewtonMethod< TypeTag >::registerParameters().

Member Data Documentation

maxError_

template<class Scalar >

Scalar Opm::NewtonMethodParams< Scalar >::maxError_

maxIterations_

template<class Scalar >

int Opm::NewtonMethodParams< Scalar >::maxIterations_

Maximum number of iterations we do before giving up.

targetIterations_

template<class Scalar >

int Opm::NewtonMethodParams< Scalar >::targetIterations_

Optimal number of iterations we want to achieve.

tolerance_

template<class Scalar >

Scalar Opm::NewtonMethodParams< Scalar >::tolerance_

verbose_

template<class Scalar >

bool Opm::NewtonMethodParams< Scalar >::verbose_

writeConvergence_

template<class Scalar >

bool Opm::NewtonMethodParams< Scalar >::writeConvergence_

---

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

• newtonmethodparams.hpp