Public Types | Public Member Functions | List of all members
Opm::GridProperty< T > Class Template Reference

#include <GridProperty.hpp>

Public Types

typedef
GridPropertySupportedKeywordInfo
< T > 		SupportedKeywordInfo
 

Public Member Functions

 GridProperty (size_t nx, size_t ny, size_t nz, const SupportedKeywordInfo &kwInfo)
 
size_t getCartesianSize () const
 
size_t getNX () const
 
size_t getNY () const
 
size_t getNZ () const
 
T iget (size_t index) const
 
T iget (size_t i, size_t j, size_t k) const
 
void iset (size_t index, T value)
 
void iset (size_t i, size_t j, size_t k, T value)
 
bool containsNaN () const
 
const std::string & getDimensionString () const
 
void multiplyWith (const GridProperty< T > &other)
 
void multiplyValueAtIndex (size_t index, T factor)
 
const std::vector< T > & getData () const
 
void maskedSet (T value, const std::vector< bool > &mask)
 
void maskedMultiply (T value, const std::vector< bool > &mask)
 
void maskedAdd (T value, const std::vector< bool > &mask)
 
void maskedCopy (const GridProperty< T > &other, const std::vector< bool > &mask)
 
void initMask (T value, std::vector< bool > &mask)
 
void loadFromDeckKeyword (DeckKeywordConstPtr deckKeyword)
 
void loadFromDeckKeyword (std::shared_ptr< const Box > inputBox, DeckKeywordConstPtr deckKeyword)
 
void copyFrom (const GridProperty< T > &src, std::shared_ptr< const Box > inputBox)
 
void scale (T scaleFactor, std::shared_ptr< const Box > inputBox)
 
void add (T shiftValue, std::shared_ptr< const Box > inputBox)
 
void setScalar (T value, std::shared_ptr< const Box > inputBox)
 
const std::string & getKeywordName () const
 
const SupportedKeywordInfo & getKeywordInfo () const
 
bool postProcessorRunRequired ()
 
void runPostProcessor ()
 
ERT::EclKW< T > getEclKW () const
 
ERT::EclKW< T > getEclKW (std::shared_ptr< const EclipseGrid > grid) const
 
void checkLimits (T min, T max) const
 

Member Typedef Documentation

template<typename T>
typedef GridPropertySupportedKeywordInfo<T> Opm::GridProperty< T >::SupportedKeywordInfo

Constructor & Destructor Documentation

template<typename T>
Opm::GridProperty< T >::GridProperty ( size_t  nx,
size_t  ny,
size_t  nz,
const SupportedKeywordInfo &  kwInfo 
)
inline

References Opm::GridPropertySupportedKeywordInfo< DataType >::getInitializer().

Member Function Documentation

template<typename T>
void Opm::GridProperty< T >::add ( T  shiftValue,
std::shared_ptr< const Box >  inputBox 
)
inline
template<typename T>
void Opm::GridProperty< T >::checkLimits ( T  min,
T  max 
) const
inline

Will check that all elements in the property are in the closed interval [min,max].

template<typename T>
bool Opm::GridProperty< T >::containsNaN ( ) const
template<typename T>
void Opm::GridProperty< T >::copyFrom ( const GridProperty< T > &  src,
std::shared_ptr< const Box >  inputBox 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
size_t Opm::GridProperty< T >::getCartesianSize ( ) const
inline

Referenced by Opm::GridProperty< T >::copyFrom(), Opm::GridProperty< T >::getEclKW(), Opm::GridProperty< T >::initMask(), Opm::GridProperty< T >::maskedAdd(), Opm::GridProperty< T >::maskedCopy(), Opm::GridProperty< T >::maskedMultiply(), and Opm::GridProperty< T >::maskedSet().

template<typename T>
const std::vector<T>& Opm::GridProperty< T >::getData ( ) const
inline

Referenced by Opm::GridProperty< T >::getEclKW().

template<typename T>
const std::string& Opm::GridProperty< T >::getDimensionString ( ) const
template<typename T>
ERT::EclKW<T> Opm::GridProperty< T >::getEclKW ( ) const
inline

References Opm::GridProperty< T >::getCartesianSize(), Opm::GridProperty< T >::getData(), and Opm::GridProperty< T >::getKeywordName().

template<typename T>
ERT::EclKW<T> Opm::GridProperty< T >::getEclKW ( std::shared_ptr< const EclipseGrid >  grid) const
inline

References Opm::GridProperty< T >::getCartesianSize(), Opm::GridProperty< T >::getKeywordName(), and Opm::GridProperty< T >::iget().

template<typename T>
const SupportedKeywordInfo& Opm::GridProperty< T >::getKeywordInfo ( ) const
inline
template<typename T>
const std::string& Opm::GridProperty< T >::getKeywordName ( ) const
inline

References Opm::GridPropertySupportedKeywordInfo< DataType >::getKeywordName().

Referenced by Opm::GridProperty< T >::getEclKW().

template<typename T>
size_t Opm::GridProperty< T >::getNX ( ) const
inline
template<typename T>
size_t Opm::GridProperty< T >::getNY ( ) const
inline
template<typename T>
size_t Opm::GridProperty< T >::getNZ ( ) const
inline
template<typename T>
T Opm::GridProperty< T >::iget ( size_t  index) const
inline

Referenced by Opm::GridProperty< T >::getEclKW(), and Opm::GridProperty< T >::iget().

template<typename T>
T Opm::GridProperty< T >::iget ( size_t  i,
size_t  j,
size_t  k 
) const
inline

References Opm::GridProperty< T >::iget().

template<typename T>
void Opm::GridProperty< T >::initMask ( T  value,
std::vector< bool > &  mask 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
void Opm::GridProperty< T >::iset ( size_t  index,
T  value 
)
inline

Referenced by Opm::GridProperty< T >::iset().

template<typename T>
void Opm::GridProperty< T >::iset ( size_t  i,
size_t  j,
size_t  k,
T  value 
)
inline

References Opm::GridProperty< T >::iset().

template<typename T>
void Opm::GridProperty< T >::loadFromDeckKeyword ( DeckKeywordConstPtr  deckKeyword)
inline

Due to the convention where it is only neceassary to supply the top layer of the petrophysical properties we can unfortunately not enforce that the number of elements elements in the deckkeyword equals nx*ny*nz.

Referenced by Opm::GridProperty< T >::loadFromDeckKeyword().

template<typename T>
void Opm::GridProperty< T >::loadFromDeckKeyword ( std::shared_ptr< const Box >  inputBox,
DeckKeywordConstPtr  deckKeyword 
)
inline

References Opm::GridProperty< T >::loadFromDeckKeyword().

template<typename T>
void Opm::GridProperty< T >::maskedAdd ( T  value,
const std::vector< bool > &  mask 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
void Opm::GridProperty< T >::maskedCopy ( const GridProperty< T > &  other,
const std::vector< bool > &  mask 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
void Opm::GridProperty< T >::maskedMultiply ( T  value,
const std::vector< bool > &  mask 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
void Opm::GridProperty< T >::maskedSet ( T  value,
const std::vector< bool > &  mask 
)
inline

References Opm::GridProperty< T >::getCartesianSize().

template<typename T>
void Opm::GridProperty< T >::multiplyValueAtIndex ( size_t  index,
T  factor 
)
inline
template<typename T>
void Opm::GridProperty< T >::multiplyWith ( const GridProperty< T > &  other)
inline
template<typename T>
bool Opm::GridProperty< T >::postProcessorRunRequired ( )
inline

References Opm::GridPropertySupportedKeywordInfo< DataType >::hasPostProcessor().

Referenced by Opm::GridProperty< T >::runPostProcessor().

template<typename T>
void Opm::GridProperty< T >::runPostProcessor ( )
inline

References Opm::GridPropertySupportedKeywordInfo< DataType >::getPostProcessor(), and Opm::GridProperty< T >::postProcessorRunRequired().

template<typename T>
void Opm::GridProperty< T >::scale ( T  scaleFactor,
std::shared_ptr< const Box >  inputBox 
)
inline
template<typename T>
void Opm::GridProperty< T >::setScalar ( T  value,
std::shared_ptr< const Box >  inputBox 
)
inline
The documentation for this class was generated from the following file: