Opm::Scaler Struct Reference

Represents scaling information for a feature. More...

#include <HybridNewtonConfig.hpp>

Public Types
enum class	Type { None , Standard , MinMax }

Public Member Functions
double	scale (double raw_value) const
double	unscale (double scaled_value) const

Public Attributes
enum Opm::Scaler::Type	type = Type::None
double	mean = 0.0
double	std = 1.0
double	min = 0.0
double	max = 1.0

Detailed Description

Represents scaling information for a feature.

Supports standard (mean/std) and min-max scaling.

Member Enumeration Documentation

Type

enum class Opm::Scaler::Type

strong

Enumerator
None
Standard
MinMax

Member Function Documentation

scale()

double Opm::Scaler::scale ( double  raw_value ) const

inline

References max, mean, min, MinMax, None, Standard, std, and type.

Referenced by Opm::BlackOilHybridNewton< TypeTag >::getPerCellFeatureValue(), and Opm::BlackOilHybridNewton< TypeTag >::getScalarFeatureValue().

unscale()

double Opm::Scaler::unscale ( double  scaled_value ) const

inline

References max, mean, min, MinMax, None, Standard, std, and type.

Member Data Documentation

max

double Opm::Scaler::max = 1.0

Referenced by scale(), and unscale().

mean

double Opm::Scaler::mean = 0.0

Referenced by scale(), and unscale().

min

double Opm::Scaler::min = 0.0

Referenced by scale(), and unscale().

std

double Opm::Scaler::std = 1.0

Referenced by scale(), and unscale().

type

enum Opm::Scaler::Type Opm::Scaler::type = Type::None

Referenced by scale(), and unscale().

---

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

• HybridNewtonConfig.hpp