Proxy class for an abstract IJK grid representation. This class is semantically abstract. Technically speaking, it is not an abstract because it can be used in case of partial transfer where we don't know the geometry of the IJK grid. More...

#include <AbstractIjkGridRepresentation.h>

Inheritance diagram for resqml2::AbstractIjkGridRepresentation:

Public Types
enum	geometryKind { UNKNOWN = 0 , EXPLICIT = 1 , PARAMETRIC = 2 , LATTICE = 3 , NO_GEOMETRY = 4 }

Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement { NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 , PILLAR = 4 }

Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

Public Member Functions
	AbstractIjkGridRepresentation (common::DataObjectRepository repo, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)

	AbstractIjkGridRepresentation (resqml2::AbstractFeatureInterpretation interp, const std::string &guid, const std::string &title, unsigned int iCount, unsigned int jCount, unsigned int kCount, bool kGaps=nullptr, eml2::AbstractHdfProxy *proxy=nullptr)

	AbstractIjkGridRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject, bool withTruncatedPillars=false)

virtual	~AbstractIjkGridRepresentation ()

unsigned int	getICellCount () const

void	setICellCount (unsigned int iCount)

unsigned int	getJCellCount () const

void	setJCellCount (unsigned int jCount)
	Sets the count of cells in the J direction. More...

uint64_t	getCellCount () const final

unsigned int	getColumnCount () const

unsigned int	getPillarCount () const

unsigned int	getKGapsCount () const

void	getKGaps (bool *kGaps) const

unsigned int	getFaceCount () const

unsigned int	getIPillarFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getJPillarFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getGlobalIndexPillarFromIjIndex (unsigned int iPillar, unsigned int jPillar) const

unsigned int	getIColumnFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getJColumnFromGlobalIndex (unsigned int globalIndex) const

unsigned int	getGlobalIndexColumnFromIjIndex (unsigned int iColumn, unsigned int jColumn) const

unsigned int	getGlobalIndexCellFromIjkIndex (unsigned int iCell, unsigned int jCell, unsigned int kCell) const

bool	isRightHanded () const

void	getPillarsOfSplitCoordinateLines (unsigned int *pillarIndices, bool reverseIAxis=false, bool reverseJAxis=false) const

void	getColumnsOfSplitCoordinateLines (unsigned int *columnIndices, bool reverseIAxis=false, bool reverseJAxis=false) const

void	getColumnCountOfSplitCoordinateLines (unsigned int *columnIndexCountPerSplitCoordinateLine) const

unsigned long	getSplitCoordinateLineCount () const

unsigned long	getBlockSplitCoordinateLineCount () const

uint64_t	getSplitNodeCount () const

void	getPillarGeometryIsDefined (bool *pillarGeometryIsDefined, bool reverseIAxis=false, bool reverseJAxis=false) const

bool	hasEnabledCellInformation () const

void	getEnabledCells (bool *enabledCells, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const

void	setEnabledCells (unsigned char enabledCells, eml2::AbstractHdfProxy proxy=nullptr)

void	loadSplitInformation ()

void	loadBlockInformation (unsigned int iInterfaceStart, unsigned int iInterfaceEnd, unsigned int jInterfaceStart, unsigned int jInterfaceEnd, unsigned int kInterfaceStart, unsigned int kInterfaceEnd)

void	unloadSplitInformation ()

bool	isColumnEdgeSplitted (unsigned int iColumn, unsigned int jColumn, unsigned int edge) const
	Checks either a given column edge is splitted or not. This method requires that you have already loaded the split information. More...

uint64_t	getXyzPointIndexFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner) const
	Gets the XYZ point index in the HDF dataset from the corner of a cell. This method requires that you have already loaded the split information. More...

void	getXyzPointOfBlockFromCellCorner (unsigned int iCell, unsigned int jCell, unsigned int kCell, unsigned int corner, const double *xyzPoints, double &x, double &y, double &z) const
	Gets the x, y and z values of the corner of a cell of a given block. This method requires that you have already both loaded the block information and get the geometry of the block thanks to getXyzPointsOfBlock(). More...

uint64_t	getXyzPointCountOfKInterface () const

uint64_t	getXyzPointCountOfBlock () const

void	getXyzPointsOfKInterface (unsigned int kInterface, double *xyzPoints)

virtual void	getXyzPointsOfKInterfaceSequence (unsigned int kInterfaceStart, unsigned int kInterfaceEnd, double *xyzPoints)
	Gets all the XYZ points of a particular sequence of K interfaces. XYZ points are given in the local CRS. More...

virtual void	getXyzPointsOfBlock (double *xyzPoints)
	Gets all the XYZ points of the current block. XYZ points are given in the local CRS. Block information must be loaded. More...

virtual bool	isNodeGeometryCompressed () const

gsoap_resqml2_0_1::resqml20__KDirection	getKDirection () const override

virtual geometryKind	getGeometryKind () const

virtual common::DataObjectReference	getHdfProxyDor () const override
	Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry). More...

virtual uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const override

virtual void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const override
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS. More...

std::string	getXmlTag () const final

unsigned int	getPatchCount () const override

virtual std::string	getXmlNamespace () const override

Public Member Functions inherited from resqml2::AbstractColumnLayerGridRepresentation
virtual	~AbstractColumnLayerGridRepresentation ()=default

unsigned int	getKCellCount () const

void	setKCellCount (unsigned int kCount)

void	setIntervalAssociationWithStratigraphicOrganizationInterpretation (uint64_t stratiUnitIndices, uint64_t nullValue, resqml2::AbstractStratigraphicOrganizationInterpretation stratiOrgInterp, eml2::AbstractHdfProxy *hdfProxy=nullptr)

common::DataObjectReference	getStratigraphicOrganizationInterpretationDor () const final

bool	hasIntervalStratigraphicUnitIndices () const

uint64_t	getIntervalStratigraphicUnitIndices (uint64_t *stratiUnitIndices)

gsoap_resqml2_0_1::resqml20__PillarShape	getMostComplexPillarGeometry () const

Public Member Functions inherited from resqml2::AbstractGridRepresentation
virtual	~AbstractGridRepresentation ()=default

std::vector< class GridConnectionSetRepresentation * >	getGridConnectionSetRepresentationSet () const

unsigned int	getGridConnectionSetRepresentationCount () const

class GridConnectionSetRepresentation *	getGridConnectionSetRepresentation (unsigned int index) const

AbstractGridRepresentation *	getParentGrid () const

common::DataObjectReference	getParentGridDor () const

std::vector< resqml2::AbstractGridRepresentation * >	getChildGridSet () const

unsigned int	getChildGridCount () const

AbstractGridRepresentation *	getChildGrid (unsigned int index) const

void	setParentWindow (uint64_t cellIndices, uint64_t cellIndexCount, class UnstructuredGridRepresentation parentGrid, eml2::AbstractHdfProxy *proxy=nullptr)

void	setParentWindow (unsigned int columnIndices, unsigned int columnIndexCount, unsigned int kLayerIndexRegridStart, unsigned int childCellCountPerInterval, unsigned int parentCellCountPerInterval, unsigned int intervalCount, class AbstractColumnLayerGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double childCellWeights=nullptr)

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int childCellCountPerIInterval, unsigned int parentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int childCellCountPerJInterval, unsigned int parentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int childCellCountPerKInterval, unsigned int parentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int constantChildCellCountPerIInterval, unsigned int constantParentCellCountPerIInterval, unsigned int iIntervalCount, unsigned int jCellIndexRegridStart, unsigned int constantChildCellCountPerJInterval, unsigned int constantParentCellCountPerJInterval, unsigned int jIntervalCount, unsigned int kCellIndexRegridStart, unsigned int constantChildCellCountPerKInterval, unsigned int constantParentCellCountPerKInterval, unsigned int kIntervalCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)
	Indicates that this grid takes place into another IJK parent grid. This method assumes that the count of cells per regrid interval is constant in both child and parent grids. More...

void	setParentWindow (unsigned int iCellIndexRegridStart, unsigned int iChildCellCount, unsigned int iParentCellCount, unsigned int jCellIndexRegridStart, unsigned int jChildCellCount, unsigned int jParentCellCount, unsigned int kCellIndexRegridStart, unsigned int kChildCellCount, unsigned int kParentCellCount, class AbstractIjkGridRepresentation parentGrid, eml2::AbstractHdfProxy proxy=nullptr, double iChildCellWeights=nullptr, double jChildCellWeights=nullptr, double *kChildCellWeights=nullptr)

void	setForcedNonRegridedParentCell (uint64_t *cellIndices, uint64_t cellIndexCount)

void	setCellOverlap (uint64_t parentChildCellPairCount, uint64_t parentChildCellPair, const std::string &volumeUom, double overlapVolumes=nullptr)

int64_t	getParentCellIndexCount () const

void	getParentCellIndices (uint64_t *parentCellIndices) const

int64_t	getParentColumnIndexCount () const

void	getParentColumnIndices (uint64_t *parentColumnIndices) const

uint64_t	getRegridStartIndexOnParentGrid (char dimension) const

uint64_t	getRegridIntervalCount (char dimension) const

bool	isRegridCellCountPerIntervalConstant (char dimension, bool childVsParentCellCount) const

uint64_t	getRegridConstantCellCountPerInterval (char dimension, bool childVsParentCellCount) const

void	getRegridCellCountPerInterval (char dimension, uint64_t *childCellCountPerInterval, bool childVsParentCellCount) const

bool	hasRegridChildCellWeights (char dimension) const

void	getRegridChildCellWeights (char dimension, double *childCellWeights) const

bool	hasForcedNonRegridedParentCell () const

void	setCellAssociationWithStratigraphicOrganizationInterpretation (uint64_t stratiUnitIndices, uint64_t nullValue, class AbstractStratigraphicOrganizationInterpretation stratiOrgInterp)

class AbstractStratigraphicOrganizationInterpretation *	getStratigraphicOrganizationInterpretation () const

bool	hasCellStratigraphicUnitIndices () const

uint64_t	getCellStratigraphicUnitIndices (uint64_t *stratiUnitIndices)

void	setCellAssociationWithRockFluidOrganizationInterpretation (uint64_t rockFluidUnitIndices, uint64_t nullValue, class RockFluidOrganizationInterpretation rockFluidOrgInterp)

class RockFluidOrganizationInterpretation *	getRockFluidOrganizationInterpretation () const

virtual common::DataObjectReference	getRockFluidOrganizationInterpretationDor () const

bool	hasCellFluidPhaseUnitIndices () const

uint64_t	getCellFluidPhaseUnitIndices (uint64_t *rockfluidUnitIndices)

bool	isTruncated () const

uint64_t	getTruncatedFaceCount () const

void	getNodeIndicesOfTruncatedFaces (uint64_t *nodeIndices) const

void	getCumulativeNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const

void	getNodeCountPerTruncatedFace (uint64_t *nodeCountPerFace) const

uint64_t	getTruncatedCellCount () const

void	getTruncatedCellIndices (uint64_t *cellIndices) const

void	getTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const

void	getCumulativeTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const

void	getTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const

void	getNonTruncatedFaceIndicesOfTruncatedCells (uint64_t *faceIndices) const

void	getCumulativeNonTruncatedFaceCountPerTruncatedCell (uint64_t *cumulativeFaceCountPerCell) const

void	getNonTruncatedFaceCountPerTruncatedCell (uint64_t *faceCountPerCell) const

void	getTruncatedFaceIsRightHanded (unsigned char *cellFaceIsRightHanded) const

void	loadTargetRelationships ()

Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()=default

class AbstractLocal3dCrs *	getLocalCrs (unsigned int patchIndex) const

virtual common::DataObjectReference	getLocalCrsDor (unsigned int patchIndex) const

std::vector< class AbstractProperty * >	getPropertySet () const

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

uint64_t	getXyzPointCountOfAllPatches () const

void	getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS. More...

void	getXyzPointsOfAllPatches (double *xyzPoints) const
	Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS. More...

bool	isInSingleLocalCrs () const

bool	isInSingleGlobalCrs () const

void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const

AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const

std::set< AbstractRepresentation * >	getAllSeismicSupport () const

void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double inlines, double crosslines, unsigned int pointCount, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy proxy)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)

void	addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double lineAbscissa, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy *proxy)

void	getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Static Public Attributes
static const char *	XML_TAG

static const char *	XML_TAG_TRUNCATED

Static Public Attributes inherited from resqml2::AbstractGridRepresentation
static const char *	XML_TAG

Static Public Attributes inherited from resqml2::AbstractRepresentation
static const char *	XML_TAG

Additional Inherited Members
Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

Proxy class for an abstract IJK grid representation. This class is semantically abstract. Technically speaking, it is not an abstract because it can be used in case of partial transfer where we don't know the geometry of the IJK grid.

Member Enumeration Documentation

◆ geometryKind

enum resqml2::AbstractIjkGridRepresentation::geometryKind

Values that represent geometry kinds.

Constructor & Destructor Documentation

◆ AbstractIjkGridRepresentation() [1/3]

resqml2::AbstractIjkGridRepresentation::AbstractIjkGridRepresentation	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	iCount,
		unsigned int	jCount,
		unsigned int	kCount,
		bool *	kGaps = `nullptr`,
		eml2::AbstractHdfProxy *	proxy = `nullptr`
	)

Constructor of an IJK grid representation without link to an interpretation.

Exceptions

std::invalid_argument If repo is nullptr.

Parameters

[in,out]	repo	A repository which will manage the memory of this instance. It cannot be null.
	guid	The guid to set to the ijk grid with no geometry representation. If empty then a new guid will be generated.
	title	The title to set to the ijk grid with no geometry representation. If empty then "unknown" title will be set.
	iCount	Count of cells in the i-direction in the grid.
	jCount	Count of cells in the j-direction in the grid.
	kCount	Number of layers in the grid.
	kGaps	(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.
[in]	proxy	(Optional) The HDF proxy for writing the `enabledCells` values. If `nullptr` (default), then the default HDF proxy will be used.

◆ AbstractIjkGridRepresentation() [2/3]

resqml2::AbstractIjkGridRepresentation::AbstractIjkGridRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	iCount,
		unsigned int	jCount,
		unsigned int	kCount,
		bool *	kGaps = `nullptr`,
		eml2::AbstractHdfProxy *	proxy = `nullptr`
	)

Constructor of an IJK grid representation with a link to an interpretation.

Exceptions

std::invalid_argument If interp is nullptr.

Parameters

[in]	interp	The interpretation this IJK grid represents. It cannot be null.
	guid	The guid to set to the ijk grid with no geometry representation. If empty then a new guid will be generated.
	title	The title to set to the ijk grid with no geometry representation. If empty then "unknown" title will be set.
	iCount	Count of cells in the I direction in the grid.
	jCount	Count of cells in the J direction in the grid.
	kCount	Number of layers in the grid.
	kGaps	(Optional) Boolean array of length KCellCount-1. TRUE if there is a gap after the corresponding layer. Won't be freed by FESAPI.
[in]	proxy	(Optional) The HDF proxy for writing the `enabledCells` values. If `nullptr` (default), then the default HDF proxy will be used.

◆ AbstractIjkGridRepresentation() [3/3]

resqml2::AbstractIjkGridRepresentation::AbstractIjkGridRepresentation	(	gsoap_resqml2_0_1::eml20__DataObjectReference *	partialObject,
		bool	withTruncatedPillars = `false`
	)

Constructor of a truncated IJK grid representation without link to an interpretation.

Exceptions

std::invalid_argument If repo is nullptr.

Parameters

[in,out]	repo	A repository which will manage the memory of this instance. It cannot be null.
	guid	The guid to set to the ijk grid with no geometry representation. If empty then a new guid will be generated.
	title	The title to set to the ijk grid with no geometry representation. If empty then "unknown" title will be set.
	iCount	Count of cells in the i-direction in the grid.
	jCount	Count of cells in the j-direction in the grid.
	kCount	Number of layers in the grid.
	truncationNodeCount	Number of additional nodes required for the truncation construction.
	truncationFaceCount	Number of additional faces required for the split and truncation construction. The construction does not modify existing face definitions, but instead uses these new faces to redefine the truncated cell geometry.
	truncationCellCount	Number of additional cells required for the truncation construction. Parent cells are replaced. Constructor of truncated IJK grid representation with a link to an interpretation.

Exceptions

std::invalid_argument If interp is nullptr.

Parameters

[in]	interp	The interpretation this IJK grid represents. It cannot be null.
	guid	The guid to set to the ijk grid with no geometry representation. If empty then a new guid will be generated.
	title	The title to set to the ijk grid with no geometry representation. If empty then "unknown" title will be set.
	iCount	Count of cells in the I direction in the grid.
	jCount	Count of cells in the J direction in the grid.
	kCount	Number of layers in the grid.
	withTruncatedPillars	(Optional) True if this IJK grid has some truncated pillars, else false (default). Only to be used in partial transfer context.
[in]	partialObject	If non-nullptr, the partial object.
	withTruncatedPillars	(Optional) True to with truncated pillars.

◆ ~AbstractIjkGridRepresentation()

virtual resqml2::AbstractIjkGridRepresentation::~AbstractIjkGridRepresentation ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ getBlockSplitCoordinateLineCount()

unsigned long resqml2::AbstractIjkGridRepresentation::getBlockSplitCoordinateLineCount ( ) const

Gets the split coordinate lines count within the block. Block information must be loaded thanks to loadBlockInformation().

Exceptions

std::invalid_argument If the block information is not loaded.

Returns: The split coordinate lines count within the block.

◆ getCellCount()

uint64_t resqml2::AbstractIjkGridRepresentation::getCellCount ( ) const

inlinefinalvirtual

Gets the total count of cells in the IJK grid.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count is strictly greater than unsigned int max.

Returns: The total count of cells in the IJK grid.

Implements resqml2::AbstractGridRepresentation.

◆ getColumnCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getColumnCount ( ) const

inline

Gets the count of columns in this grid.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.

Returns: The column count.

◆ getColumnCountOfSplitCoordinateLines()

void resqml2::AbstractIjkGridRepresentation::getColumnCountOfSplitCoordinateLines ( unsigned int * columnIndexCountPerSplitCoordinateLine ) const

Gets the cumulative count of columns impacted by all the split coordinate lines. The order of the cumulative count values corresponds to the order of the split coordinates lines.

Exceptions

std::invalid_argument	If the HDF proxy is missing.
std::invalid_argument	If there is no geometry or no split coordinate line in this grid.
std::logic_error	If the cumulative count of the columns impacted by the split coordinate lines are not stored within an HDF5 integer array.

Parameters

[out] columnIndexCountPerSplitCoordinateLine An array for receiving the cumulative count of columns impacted by the split coordinate lines.

◆ getColumnsOfSplitCoordinateLines()

void resqml2::AbstractIjkGridRepresentation::getColumnsOfSplitCoordinateLines	(	unsigned int *	columnIndices,
		bool	reverseIAxis = `false`,
		bool	reverseJAxis = `false`
	)		const

Gets all the columns impacted by all the split coordinate lines. The order of the columns corresponds to the order of the split coordinate lines.

Exceptions

std::invalid_argument	If the HDF proxy is missing.
std::invalid_argument	If there is no geometry or no split coordinate line in this grid.
std::logic_error	If the indices of the columns impacted by the split coordinate lines are not stored within an HDF5 integer array.

Parameters

[out]	columnIndices	An array for receiving the indices of the columns impacted by the split coordinate lines. It must be preallocated with a size equal to the last value of the array outputted from getColumnCountOfSplitCoordinateLines().
	reverseIAxis	(Optional) True to reverse i axis. Default value is false.
	reverseJAxis	(Optional) True to reverse j axis. Default value is false.

◆ getEnabledCells()

void resqml2::AbstractIjkGridRepresentation::getEnabledCells	(	bool *	enabledCells,
		bool	reverseIAxis = `false`,
		bool	reverseJAxis = `false`,
		bool	reverseKAxis = `false`
	)		const

Get the information about enabled and disabled (dead/invisible) cells.

Exceptions

std::invalid_argument	If this grid has no geometry or no information about enabled are disabled cells.
std::invalid_argument	If the enabled and disabled celles information is neither stored in an HDF5 boolean array nor in a boolean constant array.

Parameters

[out]	enabledCells	An array for receiving the information about enabled and disabled cells. It must have a count of getCellCount() and must follow the index ordering I then J then K. It won't be free. A zero value in `enabledCells` means that the corresponding cell is disabled. A non zero value means that the corresponding cell is enabled.
	reverseIAxis	(Optional) True to reverse i axis. Default value is false.
	reverseJAxis	(Optional) True to reverse j axis. Default value is false.
	reverseKAxis	(Optional) True to reverse k axis. Default value is false.

◆ getFaceCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getFaceCount ( ) const

Gets the count of faces in this grid. This method requires you have already loaded the split information thanks to loadSplitInformation().

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I, J or K direction is strictly greater than unsigned int max.
std::invalid_argument	If there is no geometry on this grid.

Returns: The face count.

◆ getGeometryKind()

virtual geometryKind resqml2::AbstractIjkGridRepresentation::getGeometryKind ( ) const

inlinevirtual

Gets the geometry kind of this IJK grid.

Returns: The geometry kind of this IJK grid.

Reimplemented in resqml2::IjkGridParametricRepresentation, resqml2::IjkGridNoGeometryRepresentation, resqml2::IjkGridLatticeRepresentation, and resqml2::IjkGridExplicitRepresentation.

◆ getGlobalIndexCellFromIjkIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getGlobalIndexCellFromIjkIndex	(	unsigned int	iCell,
		unsigned int	jCell,
		unsigned int	kCell
	)		const

Gets the global index of a cell from its I, J and K indices in the grid.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I, J or K direction is strictly greater than unsigned int max.
std::out_of_range	If `iCell` is greater than or equal to getICellCount().
std::out_of_range	If `jCell` is greater than or equal to getJCellCount().
std::out_of_range	If `kCell` is greater than or equal to getKCellCount().

Parameters

iCell	The I index of the cell.
jCell	The J index of the cell.
kCell	The K index of the cell.

Returns: The global index of the cell.

◆ getGlobalIndexColumnFromIjIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getGlobalIndexColumnFromIjIndex	(	unsigned int	iColumn,
		unsigned int	jColumn
	)		const

Gets the global index of a column from its I and J indices in the grid. The global (or linearized) index of a given column is i column + j column * (nI cell) where i column and j column are respectively the I and J indices of the column and nI cell is the count of cells in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `iColumn` is greater than or equal to getICellCount().
std::out_of_range	If `jColumn` is greater than or equal to getJCellCount().

Parameters

iColumn	The I index of the column.
jColumn	The J index of the column.

Returns: The global index of the column.

◆ getGlobalIndexPillarFromIjIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getGlobalIndexPillarFromIjIndex	(	unsigned int	iPillar,
		unsigned int	jPillar
	)		const

Gets the global index of a pillar from its I and J indices in the grid. The global (or linearized) index of a given pillar is i pillar + j pillar * (nI pillar) where i pillar and j pillar are respectively the I and J indices of the pillar and nI pillar is the count of pillars in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `iPillar` is strictly greater than getICellCount().
std::out_of_range	If `jPillar` is strictly greater than getJCellCount().

Parameters

iPillar	The I index of the pillar.
jPillar	The J index of the pillar.

Returns: The global index of the pillar.

◆ getHdfProxyDor()

virtual common::DataObjectReference resqml2::AbstractIjkGridRepresentation::getHdfProxyDor ( ) const

inlineoverridevirtual

Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

Exceptions

std::logic_error If this representation is partial.

Returns: The data object reference of the HDF proxy used for storing the geometry, or empty data object reference if it fails.

Implements resqml2::AbstractRepresentation.

Reimplemented in resqml2_2::IjkGridParametricRepresentation, resqml2_2::IjkGridNoGeometryRepresentation, resqml2_2::IjkGridLatticeRepresentation, resqml2_2::IjkGridExplicitRepresentation, resqml2_0_1::IjkGridParametricRepresentation, resqml2_0_1::IjkGridNoGeometryRepresentation, resqml2_0_1::IjkGridLatticeRepresentation, and resqml2_0_1::IjkGridExplicitRepresentation.

◆ getICellCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getICellCount ( ) const

Gets the count of cells in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count is strictly greater than unsigned int max.

Returns: The count of cell in the I direction.

◆ getIColumnFromGlobalIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getIColumnFromGlobalIndex ( unsigned int globalIndex ) const

Gets the I index of a column from its global index in the grid. The global (or linearized) index of a given column is i column + j column * (nI cell) where i column and j column are respectively the I and J indices of the column and nI cell is the count of cells in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `globalIndex` is out of range (greater than or equal to getColumnCount()).

Parameters

globalIndex The global index of the column for which we want to get the I index.

Returns: The I index of the column.

◆ getIPillarFromGlobalIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getIPillarFromGlobalIndex ( unsigned int globalIndex ) const

Gets the I index of a pillar from its global index in this grid. The global (or linearized) index of a given pillar is i pillar + j pillar * (nI pillar) where i pillar and j pillar are respectively the I and J indices of the pillar and nI pillar is the count of pillars in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `globalIndex` is out of range (greater than or equal to getPillarCount()).

Parameters

globalIndex The global index of the pillar for which we want to get the I index.

Returns: The I index of the pillar.

◆ getJCellCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getJCellCount ( ) const

Gets the count of cells in the J direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count is strictly greater than unsigned int max.

Returns: The count of cell in the J direction.

◆ getJColumnFromGlobalIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getJColumnFromGlobalIndex ( unsigned int globalIndex ) const

Gets the J index of a column from its global index in the grid. The global (or linearized) index of a given column is i column + j column * (nI cell) where i column and j column are respectively the I and J indices of the column and nI cell is the count of cells in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `globalIndex` is out of range (greater than or equal to getColumnCount()).

Parameters

globalIndex The global index of the column for which we want to get the J index.

Returns: The J index of the column.

◆ getJPillarFromGlobalIndex()

unsigned int resqml2::AbstractIjkGridRepresentation::getJPillarFromGlobalIndex ( unsigned int globalIndex ) const

Gets the J index of a pillar from its global index in this grid. The global (or linearized) index of a given pillar is i pillar + j pillar * (nI pillar) where i pillar and j pillar are respectively the I and J indices of the pillar and nI pillar is the count of pillars in the I direction.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::out_of_range	If `globalIndex` is out of range (greater than or equal to getPillarCount()).

Parameters

globalIndex The global index of the pillar for which we want to get the J index.

Returns: The J index of the pillar.

◆ getKDirection()

gsoap_resqml2_0_1::resqml20__KDirection resqml2::AbstractIjkGridRepresentation::getKDirection ( ) const

overridevirtual

Gets the K direction (up, down or not monotonic) of this grid.

Exceptions

std::invalid_argument If there is no geometry on this grid.

Returns: The K direction of this grid.

Implements resqml2::AbstractColumnLayerGridRepresentation.

◆ getKGaps()

void resqml2::AbstractIjkGridRepresentation::getKGaps ( bool * kGaps ) const

For each K Layer except the last one, indicate wether there is a layer or not after it.

Parameters

[out] kGaps An array for receiving the information about kGaps. It must have a count of getKCellCount() - 1. It won't be free. A false value in kGaps means that the corresponding k layer has no gaps just after it. A true value means that the corresponding k layer has a gap just after it.

◆ getKGapsCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getKGapsCount ( ) const

Gets the count of K layer gaps in this grid.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.

Returns: The K Layer gaps count.

◆ getPatchCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getPatchCount ( ) const

inlineoverridevirtual

Gets the patch count.

Returns: The patch count.

Implements resqml2::AbstractRepresentation.

◆ getPillarCount()

unsigned int resqml2::AbstractIjkGridRepresentation::getPillarCount ( ) const

inline

Gets the count of pillars in this grid.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.

Returns: The pillar count.

◆ getPillarGeometryIsDefined()

void resqml2::AbstractIjkGridRepresentation::getPillarGeometryIsDefined	(	bool *	pillarGeometryIsDefined,
		bool	reverseIAxis = `false`,
		bool	reverseJAxis = `false`
	)		const

Tells for each pillar if its geometry is defined. This method only looks at the corresponding PillarGeometryIsDefined attribute in the gSOAP proxy.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::invalid_argument	If there is no geometry on this IJK grid.
std::invalid_argument	If the values indicating for each pillar if its geometry is defined are neither stored in an HDF5 boolean array nor in a boolean constant array.

Parameters

[out]	pillarGeometryIsDefined	An array for receiving a boolean value for each pillar indicating if its geometry is defined or not. It must be preallocated with a size of getPillarCount().
	reverseIAxis	(Optional) True to reverse i axis. Default value is false.
	reverseJAxis	(Optional) True to reverse j axis. Default value is false.

◆ getPillarsOfSplitCoordinateLines()

void resqml2::AbstractIjkGridRepresentation::getPillarsOfSplitCoordinateLines	(	unsigned int *	pillarIndices,
		bool	reverseIAxis = `false`,
		bool	reverseJAxis = `false`
	)		const

Gets all the pillars which correspond to all split coordinate lines. The order of the pillars corresponds to the order of the split coordinate lines.

Exceptions

std::invalid_argument	If the HDF proxy is missing.
std::invalid_argument	If there is no geometry or no split coordinate line in this grid.
std::logic_error	If the indices of the pillars corresponding to the split coordinate lines are not stored within an HDF5 integer array.

Parameters

[out]	pillarIndices	An array for receiving the indices of the pillars corresponding to the split coordinate lines. It must be preallocated with a size of getSplitCoordinateLineCount().
	reverseIAxis	(Optional) True to reverse I axis. Default value is false.
	reverseJAxis	(Optional) True to reverse J axis. Default value is false.

◆ getSplitCoordinateLineCount()

unsigned long resqml2::AbstractIjkGridRepresentation::getSplitCoordinateLineCount ( ) const

Gets the split coordinate lines count.

Exceptions

std::invalid_argument	If there is no geometry on this IJK grid.
std::range_error	If the count of split coordinate lines is strictly greater than unsigned int max.

Returns: The split coordinate lines count.

◆ getSplitNodeCount()

uint64_t resqml2::AbstractIjkGridRepresentation::getSplitNodeCount ( ) const

Gets the split nodes count.

Exceptions

std::invalid_argument If there is no geometry on this IJK grid.

Returns: The split nodes count.

◆ getXmlNamespace()

virtual std::string resqml2::AbstractIjkGridRepresentation::getXmlNamespace ( ) const

inlineoverridevirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

Reimplemented in resqml2_2::IjkGridParametricRepresentation, resqml2_2::IjkGridNoGeometryRepresentation, resqml2_2::IjkGridLatticeRepresentation, resqml2_2::IjkGridExplicitRepresentation, resqml2_0_1::IjkGridParametricRepresentation, resqml2_0_1::IjkGridNoGeometryRepresentation, resqml2_0_1::IjkGridLatticeRepresentation, and resqml2_0_1::IjkGridExplicitRepresentation.

◆ getXmlTag()

std::string resqml2::AbstractIjkGridRepresentation::getXmlTag ( ) const

finalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ getXyzPointCountOfBlock()

uint64_t resqml2::AbstractIjkGridRepresentation::getXyzPointCountOfBlock ( ) const

Gets the XYZ points count of the current block. Block information must be loaded.

Exceptions

std::invalid_argument If the block information is not loaded.

Returns: The XYZ point count of the current block.

◆ getXyzPointCountOfKInterface()

uint64_t resqml2::AbstractIjkGridRepresentation::getXyzPointCountOfKInterface ( ) const

Get the XYZ points count in each K layer interface.

Exceptions

std::logic_error	If this grid is partial.
std::range_error	If the count of cells in I or J direction is strictly greater than unsigned int max.
std::invalid_argument	If there is no geometry on this IJK grid.
std::range_error	If the count of split coordinate lines is strictly greater than unsigned int max.

Returns: The XYZ point count of each K layer interface.

◆ getXyzPointCountOfPatch()

virtual uint64_t resqml2::AbstractIjkGridRepresentation::getXyzPointCountOfPatch ( unsigned int patchIndex ) const

overridevirtual

Get the xyz point count in a given patch of this representation.

Exceptions

std::out_of_range	If `patchIndex` is out of range.
std::logic_error	If this representation is partial.

Parameters

patchIndex Zero-based index of the patch from which we look for the xyz points.

Returns: The xyz point count of the patch at position patchIndex.

Implements resqml2::AbstractRepresentation.

Reimplemented in resqml2::IjkGridNoGeometryRepresentation.

◆ getXyzPointIndexFromCellCorner()

uint64_t resqml2::AbstractIjkGridRepresentation::getXyzPointIndexFromCellCorner	(	unsigned int	iCell,
		unsigned int	jCell,
		unsigned int	kCell,
		unsigned int	corner
	)		const

Gets the XYZ point index in the HDF dataset from the corner of a cell. This method requires that you have already loaded the split information.

Exceptions

std::logic_error	If this grid is partial.
std::invalid_argument	If the split information is not loaded.
std::out_of_range	If `iCell` `>` getICellCount(), `jCell` `>` getJCellCount() or `kCell` `>` getKCellCount().
std::out_of_range	If `corner` `>` 7.

Parameters

iCell	The I index of the cell.
jCell	The J index of the cell.
kCell	The K index of the cell.
corner	Index of the corner: 0 for (0,0,0); 1 for (1,0,0); 2 for (1,1,0); 3 for (0,1, 0); 4 for (0,0,1); 5 for (1,0,1); 6 for (1,1,1); 7 for (0,1,1).

Returns: The index of the XYZ point in the HDF dataset corresponding to the corner of the cell. Keep in mind to multiply the result by 3 to get the X index since the points are triplet of values.

◆ getXyzPointOfBlockFromCellCorner()

void resqml2::AbstractIjkGridRepresentation::getXyzPointOfBlockFromCellCorner	(	unsigned int	iCell,
		unsigned int	jCell,
		unsigned int	kCell,
		unsigned int	corner,
		const double *	xyzPoints,
		double &	x,
		double &	y,
		double &	z
	)		const

Gets the x, y and z values of the corner of a cell of a given block. This method requires that you have already both loaded the block information and get the geometry of the block thanks to getXyzPointsOfBlock().

Exceptions

std::logic_error	If this grid is partial.
std::invalid_argument	If the split or block information is not loaded.
std::out_of_range	If `iCell` `>` getICellCount(), `jCell` `>` getJCellCount() or `kCell` `>` getKCellCount().
std::out_of_range	If `corner` `>` 7.

Parameters

	iCell	The I index of the cell.
	jCell	The J index of the cell.
	kCell	The K index of the cell.
	corner	Index of the corner: 0 for (0,0,0); 1 for (1,0,0); 2 for (1,1,0); 3 for (0,1,0); 4 for (0,0,1); 5 for (1,0,1); 6 for (1,1,1); 7 for (0,1, 1).
	xyzPoints	The XYZ points of the block (resulting from a call to getXyzPointsOfBlock()).
[out]	x	The x value of the corner we look for.
[out]	y	The y value of the corner we look for.
[out]	z	The z value of the corner we look for.

◆ getXyzPointsOfBlock()

virtual void resqml2::AbstractIjkGridRepresentation::getXyzPointsOfBlock ( double * xyzPoints )

virtual

Gets all the XYZ points of the current block. XYZ points are given in the local CRS. Block information must be loaded.

Exceptions

std::invalid_argument	If the block information is not loaded.
std::invalid_argument	If `xyzPoints` is `nullptr`.

Parameters

[out] xyzPoints A linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be pre allocated with a size of 3 * getXyzPointCountOfBlock().

Reimplemented in resqml2::IjkGridExplicitRepresentation, and resqml2::IjkGridParametricRepresentation.

◆ getXyzPointsOfKInterface()

void resqml2::AbstractIjkGridRepresentation::getXyzPointsOfKInterface	(	unsigned int	kInterface,
		double *	xyzPoints
	)

Please do note use: not implemented yet.

◆ getXyzPointsOfKInterfaceSequence()

virtual void resqml2::AbstractIjkGridRepresentation::getXyzPointsOfKInterfaceSequence	(	unsigned int	kInterfaceStart,
		unsigned int	kInterfaceEnd,
		double *	xyzPoints
	)

virtual

Gets all the XYZ points of a particular sequence of K interfaces. XYZ points are given in the local CRS.

Exceptions

std::out_of_range	If `kInterfaceStart` `>` getKCellCount() or `kInterfaceEnd` `>` getKCellCount() + getKGapsCount().
std::range_error	If `kInterfaceStart` `>` `kInterfaceEnd`.
std::invalid_argument	If `xyzPoints` is `nullptr`.

Parameters

	kInterfaceStart	The K index of the starting interface taken from zero to getKCellCount().
	kInterfaceEnd	The K index of the ending interface taken from zero to getKCellCount() + getKGapsCount().
[out]	xyzPoints	A linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be preallocated with a size of `3 ` getXyzPointCountOfKInterface() ` (kInterfaceEnd - kInterfaceStart + 1)`.

Reimplemented in resqml2::IjkGridExplicitRepresentation, and resqml2::IjkGridParametricRepresentation.

◆ getXyzPointsOfPatch()

virtual void resqml2::AbstractIjkGridRepresentation::getXyzPointsOfPatch	(	unsigned int	patchIndex,
		double *	xyzPoints
	)		const

overridevirtual

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions

std::out_of_range If patchIndex >= getPatchCount().

Parameters

patchIndex	The index of the patch.
xyzPoints	xyz double triplets ordered by i then j then split then k. It must be preallocated with a count of `((iCellCount+1) * (jCellCount+1) + splitCoordinateLineCount)` `* kCellCount.`

Implements resqml2::AbstractRepresentation.

Reimplemented in resqml2_2::IjkGridParametricRepresentation, resqml2_2::IjkGridExplicitRepresentation, resqml2_0_1::IjkGridParametricRepresentation, resqml2_0_1::IjkGridExplicitRepresentation, resqml2::IjkGridNoGeometryRepresentation, and resqml2::IjkGridLatticeRepresentation.

◆ hasEnabledCellInformation()

bool resqml2::AbstractIjkGridRepresentation::hasEnabledCellInformation ( ) const

Indicates if this grid contains information about enabled and disabled (dead/invisible) cells.

Returns: True if this grid contains information about enabled and disabled cells, false if not.

◆ isColumnEdgeSplitted()

bool resqml2::AbstractIjkGridRepresentation::isColumnEdgeSplitted	(	unsigned int	iColumn,
		unsigned int	jColumn,
		unsigned int	edge
	)		const

Checks either a given column edge is splitted or not. This method requires that you have already loaded the split information.

Exceptions

std::logic_error	If this grid is partial.
std::invalid_argument	If the split information is not loaded.
std::out_of_range	If `iColumn` is strictly greater than getICellCount().
std::out_of_range	If `iColumn` is strictly greater than getJCellCount().
std::out_of_range	If `edge` is strictly greater than 3.

Parameters

iColumn	The I index of the column.
jColumn	The J index of the column.
edge	0 for edge from i to i+1, lower j connection; 1 for edge from j to j+1, upper i connection; 2 for edge from i+1 to i, upper j connection; 3 for edge from j+1 to j, lower i connection.

Returns: True if the column edge is splitted, false if not.

◆ isNodeGeometryCompressed()

virtual bool resqml2::AbstractIjkGridRepresentation::isNodeGeometryCompressed ( ) const

inlinevirtual

Checks whether the node geometry dataset is compressed or not.

Exceptions

std::invalid_argument If this grid has no geometry.

Returns: True if the node geometry dataset is compressed, false if not.

Reimplemented in resqml2::IjkGridParametricRepresentation, and resqml2::IjkGridExplicitRepresentation.

◆ isRightHanded()

bool resqml2::AbstractIjkGridRepresentation::isRightHanded ( ) const

Queries if this grid is right handed, as determined by the triple product of tangent vectors in the I, J, and K directions.

Exceptions

std::logic_error If this grid has no geometry. Or, if it is in an unrecognized version of RESQML.

Returns: True if this grid is right handed, false if it is not.

◆ loadBlockInformation()

void resqml2::AbstractIjkGridRepresentation::loadBlockInformation	(	unsigned int	iInterfaceStart,
		unsigned int	iInterfaceEnd,
		unsigned int	jInterfaceStart,
		unsigned int	jInterfaceEnd,
		unsigned int	kInterfaceStart,
		unsigned int	kInterfaceEnd
	)

Loads the block information into memory to speed up the processes and make easier block geometry handling for the user. This method requires that you have already loaded the split information.

Exceptions

std::logic_error	If this grid is partial.
std::invalid_argument	If the split information is not loaded.
std::out_of_range	If `iInterfaceEnd` `>` getICellCount(), `jInterfaceEnd` `>` getJCellCount() or `kInterfaceEnd` `>` getKCellCount() + getKGapsCount().
std::range_error	If `iInterfaceStart` `>` `iInterfaceEnd`, `jInterfaceStart` `>` `jInterfaceEnd` or `kInterfaceStart` `>` `kInterfaceEnd`.

Parameters

iInterfaceStart	The starting I interface index of the block taken from zero to getICellCount().
iInterfaceEnd	The ending I interface index of the block taken from zero to getICellCount().
jInterfaceStart	The starting J interface index of the block taken from zero to getJCellCount().
jInterfaceEnd	The ending J interface index of the block taken from zero to getJCellCount().
kInterfaceStart	The starting K interface index of the block taken from zero to getKCellCount() + getKGapsCount().
kInterfaceEnd	The ending K interface index of the block taken from zero to getKCellCount().

◆ loadSplitInformation()

void resqml2::AbstractIjkGridRepresentation::loadSplitInformation ( )

Loads the split information into memory to speed up processes. Be aware that you must unload by yourself this memory thanks to unloadSplitInformation().

◆ setEnabledCells()

void resqml2::AbstractIjkGridRepresentation::setEnabledCells	(	unsigned char *	enabledCells,
		eml2::AbstractHdfProxy *	proxy = `nullptr`
	)

Sets the information about the enabled and disabled (dead/invisible) cells.

Exceptions

std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined in the repository.
std::invalid_argument	If this grid has no geometry.

Parameters

[in]	enabledCells	An array containing the enabled/disabled information for each cell. It must have a count of getCellCount() and must follow the index ordering I then J then K. A zero value in `enabledCells` means that the corresponding cell is disabled. A non zero value means that the corresponding cell is enabled.
[in]	proxy	(Optional) The HDF proxy for writing the `enabledCells` values. If `nullptr` (default), then the default HDF proxy will be used.

◆ setICellCount()

void resqml2::AbstractIjkGridRepresentation::setICellCount ( unsigned int iCount )

Sets the count of cells in the I direction.

Exceptions

std::logic_error If this grid is partial.

Parameters

iCount The count of cells to set in the I direction.

◆ setJCellCount()

void resqml2::AbstractIjkGridRepresentation::setJCellCount ( unsigned int jCount )

Sets the count of cells in the J direction.

Exceptions

std::logic_error If this grid is partial.

Parameters

jCount The count of cells to set in the J direction.

◆ unloadSplitInformation()

void resqml2::AbstractIjkGridRepresentation::unloadSplitInformation ( )

Unloads the split information from memory.

Member Data Documentation

◆ XML_TAG

const char* resqml2::AbstractIjkGridRepresentation::XML_TAG

static

The standard XML tag without XML namespace for serializing this data object.

◆ XML_TAG_TRUNCATED

const char* resqml2::AbstractIjkGridRepresentation::XML_TAG_TRUNCATED

static

The standard XML tag without XML namespace for serializing this data object if truncated.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2/AbstractIjkGridRepresentation.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ geometryKind

Constructor & Destructor Documentation

◆ AbstractIjkGridRepresentation() [1/3]

◆ AbstractIjkGridRepresentation() [2/3]

◆ AbstractIjkGridRepresentation() [3/3]

◆ ~AbstractIjkGridRepresentation()

Member Function Documentation

◆ getBlockSplitCoordinateLineCount()

◆ getCellCount()

◆ getColumnCount()

◆ getColumnCountOfSplitCoordinateLines()

◆ getColumnsOfSplitCoordinateLines()

◆ getEnabledCells()

◆ getFaceCount()

◆ getGeometryKind()

◆ getGlobalIndexCellFromIjkIndex()

◆ getGlobalIndexColumnFromIjIndex()

◆ getGlobalIndexPillarFromIjIndex()

◆ getHdfProxyDor()

◆ getICellCount()

◆ getIColumnFromGlobalIndex()

◆ getIPillarFromGlobalIndex()

◆ getJCellCount()

◆ getJColumnFromGlobalIndex()

◆ getJPillarFromGlobalIndex()

◆ getKDirection()

◆ getKGaps()

◆ getKGapsCount()

◆ getPatchCount()

◆ getPillarCount()

◆ getPillarGeometryIsDefined()

◆ getPillarsOfSplitCoordinateLines()

◆ getSplitCoordinateLineCount()

◆ getSplitNodeCount()

◆ getXmlNamespace()

◆ getXmlTag()

◆ getXyzPointCountOfBlock()

◆ getXyzPointCountOfKInterface()

◆ getXyzPointCountOfPatch()

◆ getXyzPointIndexFromCellCorner()

◆ getXyzPointOfBlockFromCellCorner()

◆ getXyzPointsOfBlock()

◆ getXyzPointsOfKInterface()

◆ getXyzPointsOfKInterfaceSequence()

◆ getXyzPointsOfPatch()

◆ hasEnabledCellInformation()

◆ isColumnEdgeSplitted()

◆ isNodeGeometryCompressed()

◆ isRightHanded()

◆ loadBlockInformation()

◆ loadSplitInformation()

◆ setEnabledCells()

◆ setICellCount()

◆ setJCellCount()

◆ unloadSplitInformation()

Member Data Documentation

◆ XML_TAG

◆ XML_TAG_TRUNCATED