My Project
Dune::cpgrid::CpGridData Class Reference

Struct that hods all the data needed to represent a Cpgrid. More...

#include <CpGridData.hpp>

Public Types

enum  { MAX_DATA_PER_CELL = 2 }
 
enum  AttributeSet { owner , overlap , copy }
 The type of the set of the attributes.
 

Public Member Functions

 CpGridData (MPIHelper::MPICommunicator comm)
 Constructor for parallel grid data. More...
 
 CpGridData ()
 Constructor.
 
 ~CpGridData ()
 Destructor.
 
int size (int codim) const
 number of leaf entities per codim in this process
 
int size (GeometryType type) const
 number of leaf entities per geometry type in this process
 
void readSintefLegacyFormat (const std::string &grid_prefix)
 Read the Sintef legacy grid format ('topogeom'). More...
 
void writeSintefLegacyFormat (const std::string &grid_prefix) const
 Write the Sintef legacy grid format ('topogeom'). More...
 
void readEclipseFormat (const std::string &filename, bool periodic_extension, bool turn_normals=false)
 Read the Eclipse grid format ('grdecl'). More...
 
void processEclipseFormat (const grdecl &input_data, Opm::EclipseState *ecl_state, std::array< std::set< std::pair< int, int > >, 2 > &nnc, bool remove_ij_boundary, bool turn_normals, bool pinchActive)
 Read the Eclipse grid format ('grdecl'). More...
 
void getIJK (int c, std::array< int, 3 > &ijk) const
 Extract Cartesian index triplet (i,j,k) of an active cell. More...
 
void computeUniqueBoundaryIds ()
 
bool uniqueBoundaryIds () const
 Is the grid currently using unique boundary ids? More...
 
void setUniqueBoundaryIds (bool uids)
 Set whether we want to have unique boundary ids. More...
 
const std::vector< double > & zcornData () const
 Return the internalized zcorn copy from the grid processing, if no cells were adjusted during the minpvprocessing this can be and empty vector.
 
const IndexSetindexSet () const
 Get the index set. More...
 
const std::array< int, 3 > & logicalCartesianSize () const
 The logical cartesian size of the grid. More...
 
void distributeGlobalGrid (CpGrid &grid, const CpGridData &view_data, const std::vector< int > &cell_part)
 Redistribute a global grid. More...
 
template<class DataHandle >
void communicate (DataHandle &data, InterfaceType iftype, CommunicationDirection dir)
 communicate objects for all codims on a given level More...
 
const std::vector< int > & sortedNumAquiferCells () const
 Get sorted active cell indices of numerical aquifer.
 

Friends

template<class T , int i>
struct mover::Mover
 
class GlobalIdSet
 
class Dune::CpGrid
 
template<int >
class Entity
 
template<int >
class EntityRep
 
class Intersection
 
class PartitionTypeIndicator
 

Detailed Description

Struct that hods all the data needed to represent a Cpgrid.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MAX_DATA_PER_CELL 

The maximum data items allowed per cell (DUNE < 2.5.2)

    Due to a bug in DUNE < 2.5.2 we need to limit this when
    communicating. 1 is big enough for OPM as we always use
    one block for all unknowns, but some DUNE's grid checks
    actually need 2. So 2 it is. 

Constructor & Destructor Documentation

◆ CpGridData()

Dune::cpgrid::CpGridData::CpGridData ( MPIHelper::MPICommunicator  comm)
explicit

Constructor for parallel grid data.

Parameters
commThe MPI communicator Default constructor.

Member Function Documentation

◆ communicate()

template<class DataHandle >
void Dune::cpgrid::CpGridData::communicate ( DataHandle &  data,
InterfaceType  iftype,
CommunicationDirection  dir 
)

communicate objects for all codims on a given level

Parameters
dataThe data handle describing the data. Has to adhere to the Dune::DataHandleIF interface.
iftypeThe interface to use for the communication.
dirThe direction of the communication along the interface (forward or backward).

◆ distributeGlobalGrid()

void Dune::cpgrid::CpGridData::distributeGlobalGrid ( CpGrid grid,
const CpGridData view_data,
const std::vector< int > &  cell_part 
)

Redistribute a global grid.

The whole grid must be available on all processors.

◆ getIJK()

void Dune::cpgrid::CpGridData::getIJK ( int  c,
std::array< int, 3 > &  ijk 
) const
inline

Extract Cartesian index triplet (i,j,k) of an active cell.

Parameters
[in]cActive cell index.
[out]ijkCartesian index triplet

◆ indexSet()

const IndexSet & Dune::cpgrid::CpGridData::indexSet ( ) const
inline

Get the index set.

This is the lead as well as th level index set.

Returns
The index set.

◆ logicalCartesianSize()

const std::array< int, 3 > & Dune::cpgrid::CpGridData::logicalCartesianSize ( ) const
inline

The logical cartesian size of the grid.

This function is not part of the Dune grid interface, and should be used with caution.

◆ processEclipseFormat()

void Dune::cpgrid::CpGridData::processEclipseFormat ( const grdecl input_data,
Opm::EclipseState *  ecl_state,
std::array< std::set< std::pair< int, int > >, 2 > &  nnc,
bool  remove_ij_boundary,
bool  turn_normals,
bool  pinchActive 
)

Read the Eclipse grid format ('grdecl').

Read the Eclipse grid format ('.grdecl').

Parameters
input_datathe data in grdecl format, declared in preprocess.h.
ecl_statethe object from opm-parser provide information regarding to pore volume, NNC, aquifer information when ecl_state is available. NNC and aquifer connection information will also be updated during the function call when available and necessary.
nncis the non-neighboring connections
remove_ij_boundaryif true, will remove (i, j) boundaries. Used internally.
pinchActiveIf true, we will add faces between vertical cells that have only inactive cells or cells with zero volume between them. If false these cells will not be connected.

◆ readEclipseFormat()

void Dune::cpgrid::CpGridData::readEclipseFormat ( const std::string &  filename,
bool  periodic_extension,
bool  turn_normals = false 
)

Read the Eclipse grid format ('grdecl').

Parameters
filenamethe name of the file to read.
periodic_extensionif true, the grid will be (possibly) refined, so that intersections/faces along i and j boundaries will match those on the other side. That is, i- faces will match i+ faces etc.

◆ readSintefLegacyFormat()

void Dune::cpgrid::CpGridData::readSintefLegacyFormat ( const std::string &  grid_prefix)

Read the Sintef legacy grid format ('topogeom').

Parameters
grid_prefixthe grid name, such that topology is found in <grid_prefix>-topo.dat etc.

◆ setUniqueBoundaryIds()

void Dune::cpgrid::CpGridData::setUniqueBoundaryIds ( bool  uids)
inline

Set whether we want to have unique boundary ids.

Parameters
uidsif true, each boundary intersection will have a unique boundary id.

◆ uniqueBoundaryIds()

bool Dune::cpgrid::CpGridData::uniqueBoundaryIds ( ) const
inline

Is the grid currently using unique boundary ids?

Returns
true if each boundary intersection has a unique id false if we use the (default) 1-6 ids for i- i+ j- j+ k- k+ boundaries.

◆ writeSintefLegacyFormat()

void Dune::cpgrid::CpGridData::writeSintefLegacyFormat ( const std::string &  grid_prefix) const

Write the Sintef legacy grid format ('topogeom').

Read the Sintef legacy grid format ('topogeom').

Parameters
grid_prefixthe grid name, such that topology will be found in <grid_prefix>-topo.dat etc.

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