Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
resqml2::IjkGridNoGeometryRepresentation Class Reference

This class is dedicated to IJK grids with undefined IjkGridGeometry. There are two main use cases. A first one is block-centered grid, where no geometry is attached to nodes but a property should spatialize cells centers. A second one is LGRs (local refinement grids), where the refined geometry is given thanks to refinement parameters. More...

#include <IjkGridNoGeometryRepresentation.h>

Inheritance diagram for resqml2::IjkGridNoGeometryRepresentation:
resqml2::AbstractIjkGridRepresentation

Public Member Functions

virtual ~IjkGridNoGeometryRepresentation ()=default
 
uint64_t getXyzPointCountOfPatch (unsigned int patchIndex) const final
 
void getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
 
geometryKind getGeometryKind () const final
 
- Public Member Functions inherited from 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)
 
 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.
 
uint64_t getCellCount () const final
 
unsigned int getColumnCount () const
 
unsigned int getPillarCount () const
 
uint64_t getKGapsCount () const
 
void getKGaps (bool *kGaps) const
 
uint64_t 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
 
uint64_t getSplitCoordinateLineCount () const
 
uint64_t getBlockSplitCoordinateLineCount () const
 
uint64_t getSplitNodeCount () const
 
void getPillarGeometryIsDefined (bool *pillarGeometryIsDefined, bool reverseIAxis=false, bool reverseJAxis=false) const
 
bool hasCellGeometryIsDefinedFlags () const
 
void getCellGeometryIsDefinedFlags (bool *cellGeometryIsDefinedFlags, bool reverseIAxis=false, bool reverseJAxis=false, bool reverseKAxis=false) const
 
void setCellGeometryIsDefinedFlags (uint8_t *cellGeometryIsDefinedFlags, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void setAllCellGeometryFlagsToDefined ()
 
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.
 
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.
 
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().
 
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.
 
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.
 
virtual bool isNodeGeometryCompressed () const
 
gsoap_resqml2_0_1::resqml20__KDirection getKDirection () const override
 
virtual common::DataObjectReference getHdfProxyDor () const override
 
std::string getXmlTag () const final
 
uint64_t getPatchCount () const override
 
virtual std::string getXmlNamespace () const override
 

Additional Inherited Members

- Public Types inherited from resqml2::AbstractIjkGridRepresentation
enum class  geometryKind {
  UNKNOWN = 0 , EXPLICIT = 1 , PARAMETRIC = 2 , LATTICE = 3 ,
  NO_GEOMETRY = 4
}
 
- Static Public Attributes inherited from resqml2::AbstractIjkGridRepresentation
static constexpr char const * XML_TAG = "IjkGridRepresentation"
 
static constexpr char const * XML_TAG_TRUNCATED = "TruncatedIjkGridRepresentation"
 

Detailed Description

This class is dedicated to IJK grids with undefined IjkGridGeometry. There are two main use cases. A first one is block-centered grid, where no geometry is attached to nodes but a property should spatialize cells centers. A second one is LGRs (local refinement grids), where the refined geometry is given thanks to refinement parameters.

Constructor & Destructor Documentation

◆ ~IjkGridNoGeometryRepresentation()

virtual resqml2::IjkGridNoGeometryRepresentation::~IjkGridNoGeometryRepresentation ( )
virtualdefault

Destructor does nothing since the memory is managed by the gSOAP context.

Member Function Documentation

◆ getGeometryKind()

geometryKind resqml2::IjkGridNoGeometryRepresentation::getGeometryKind ( ) const
finalvirtual

Gets the geometry kind of this IJK grid.

Returns
The geometry kind of this IJK grid.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getXyzPointCountOfPatch()

uint64_t resqml2::IjkGridNoGeometryRepresentation::getXyzPointCountOfPatch ( unsigned int patchIndex) const
finalvirtual

Get the XYZ point count in a given patch of this grid.

Exceptions
std::out_of_rangeIf patchIndex >= 1 (IJK grids only carry 1 patch).
std::logic_errorIf getting the XYZ points of this grid is not yet supported.
Parameters
patchIndexZero-based index of the patch from which we look for the XYZ points.
Returns
The XYZ point count of the patch.

Reimplemented from resqml2::AbstractIjkGridRepresentation.

◆ getXyzPointsOfPatch()

void resqml2::IjkGridNoGeometryRepresentation::getXyzPointsOfPatch ( unsigned int patchIndex,
double * xyzPoints ) const
finalvirtual

Please do not use: not implemented yet. Please use parent window information or geometrical property information.

Exceptions
std::_out_of_rangeIf patchIndex >= 1 (IJK grids only carry 1 patch).

Reimplemented from resqml2::AbstractIjkGridRepresentation.

The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0