Opm::Selector< Scalar > Class Template Reference

Selection. Choose first of two elements if selection basis element is nonnegative. More...

#include <AutoDiffHelpers.hpp>

Public Types

enum  CriterionForLeftElement {
  GreaterEqualZero, GreaterZero, Zero, NotEqualZero,
  LessZero, LessEqualZero, NotNaN
}
 
typedef AutoDiffBlock< Scalar > ADB
 

Public Member Functions

 Selector (const typename ADB::V &selection_basis, CriterionForLeftElement crit=GreaterEqualZero)
 
ADB select (const ADB &x1, const ADB &x2) const
 Apply selector to ADB quantities. More...
 
ADB::V select (const typename ADB::V &x1, const typename ADB::V &x2) const
 Apply selector to ADB quantities. More...
 

Detailed Description

template<typename Scalar>
class Opm::Selector< Scalar >

Selection. Choose first of two elements if selection basis element is nonnegative.

Member Typedef Documentation

template<typename Scalar>
typedef AutoDiffBlock<Scalar> Opm::Selector< Scalar >::ADB

Member Enumeration Documentation

template<typename Scalar>
enum Opm::Selector::CriterionForLeftElement
Enumerator
GreaterEqualZero 
GreaterZero 
Zero 
NotEqualZero 
LessZero 
LessEqualZero 
NotNaN 

Constructor & Destructor Documentation

template<typename Scalar>
Opm::Selector< Scalar >::Selector ( const typename ADB::V selection_basis,
CriterionForLeftElement  crit = GreaterEqualZero 
)
inline

Member Function Documentation

template<typename Scalar>
ADB Opm::Selector< Scalar >::select ( const ADB x1,
const ADB x2 
) const
inline
template<typename Scalar>
ADB::V Opm::Selector< Scalar >::select ( const typename ADB::V x1,
const typename ADB::V x2 
) const
inline

Apply selector to ADB quantities.

References Opm::subset(), and Opm::superset().


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