Opm::ECLInitFileData Class Reference

#include <ECLResultData.hpp>

Public Member Functions
	ECLInitFileData ()=delete
	ECLInitFileData (boost::filesystem::path initFile)
	ECLInitFileData (std::shared_ptr< ecl_file_type > initFile)
	ECLInitFileData (const ECLInitFileData &rhs)
	ECLInitFileData (ECLInitFileData &&rhs)
ECLInitFileData &	operator= (const ECLInitFileData &rhs)
ECLInitFileData &	operator= (ECLInitFileData &&rhs)
	~ECLInitFileData ()
	Destructor. More...
bool	haveKeywordData (const std::string &vector, const std::string &gridID="") const
template<typename T >
std::vector< T >	keywordData (const std::string &vector, const std::string &gridID="") const

Friends
class	ECLGraph

Detailed Description

Representation of an ECLIPSE Initialization result-set.

This class is aware of the internal structure of ECLIPSE INIT files and queries only those objects that pertain to a single grid.

Constructor & Destructor Documentation

ECLInitFileData() [1/5]

Opm::ECLInitFileData::ECLInitFileData ( )

delete

ECLInitFileData() [2/5]

Opm::ECLInitFileData::ECLInitFileData ( boost::filesystem::path  initFile )

explicit

Constructor.

Construct from filename. Owning semantics.

Parameters

[in]

casePrefix

Name or prefix of ECL result data.

ECLInitFileData() [3/5]

Opm::ECLInitFileData::ECLInitFileData ( std::shared_ptr< ecl_file_type >  initFile )

explicit

Constructor.

Construct from dataset already input through other means.

Non-owning/shared ownership semantics.

ECLInitFileData() [4/5]

Opm::ECLInitFileData::ECLInitFileData

(

const ECLInitFileData &

rhs

)

Copy constructor.

Parameters

[in]

rhs

Object from which to construct new instance.

ECLInitFileData() [5/5]

Opm::ECLInitFileData::ECLInitFileData

(

ECLInitFileData &&

rhs

)

Move constructor.

Parameters

[in,out]

rhs

Object from which to construct new instance. Its internal implementation will be subsumed into the new object.

~ECLInitFileData()

Opm::ECLInitFileData::~ECLInitFileData

(

)

Destructor.

Member Function Documentation

haveKeywordData()

bool Opm::ECLInitFileData::haveKeywordData	(	const std::string &	vector,
		const std::string &	gridID = ""
	)		const

Query current result-set view for availability of particular named result vector in particular enumerated grid.

Parameters

[in]	vector	Named result vector for which to query data availability.
[in]	gridID	Identity of specific grid for which to query data availability. Empty for the main grid.

Returns

Whether or not keyword data for the named result vector is available in the specific grid.

keywordData()

template<typename T >

std::vector< T > Opm::ECLInitFileData::keywordData	(	const std::string &	vector,
		const std::string &	gridID = ""
	)		const

Retrieve current result-set view's data values for particular named result vector in particular enumerated grid.

Will fail (throw an exception of type std::invalid_argument) unless the requested keyword data is available in the specific grid in the current active view.

Template Parameters

T

Element type of return value. The underlying keyword data will be converted to this type if needed and possible. Note that some type combinations do not make sense. It is, for instance, not possible to retrieve keyword values of an underlying arithmetic type in the form of a std::vector<std::string> . Similarly, we cannot access underlying character data through elements of an arithmetic type (e.g., std::vector<double> .)

Parameters

[in]	vector	Named result vector for which to retrieve keyword data.
[in]	gridID	Identity of specific grid for which to retrieve keyword data. Empty for the main grid.

Returns

Keyword data values. Empty if type conversion fails.

operator=() [1/2]

ECLInitFileData & Opm::ECLInitFileData::operator=

(

const ECLInitFileData &

rhs

)

Assignment operator.

Parameters

[in]

rhs

Object from which to assign new values to current instance.

Returns

*this 

.

operator=() [2/2]

ECLInitFileData & Opm::ECLInitFileData::operator=

(

ECLInitFileData &&

rhs

)

Move assignment operator.

Parameters

[in,out]

Object

from which to assign new instance values. Its internal implementation will be subsumed into this instance.

Returns

*this 

.

Friends And Related Function Documentation

ECLGraph

friend class ECLGraph

friend

---

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

• ECLResultData.hpp