Public Member Functions | Protected Attributes | List of all members
Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions > Class Template Reference

#include <GridDataOutput.hpp>

Public Member Functions

 SimMeshDataAccessor (const GridView &gridView, Dune::PartitionSet< partitions > dunePartition)
 Construct a SimMeshDataAccessor working on a specific GridView and specialize to a Dune::PartitionSet<>. More...
 
bool polyhedralCellPresent () const
 
void countEntities ()
 
template<typename T >
long writeGridPoints (T *x_inout, T *y_inout, T *z_inout, long max_size=0) const
 
template<typename VectType >
long writeGridPoints (VectType &x_inout, VectType &y_inout, VectType &z_inout) const
 
template<typename T >
long writeGridPoints_AOS (T *xyz_inout, long max_size=0) const
 
template<typename VectType >
long writeGridPoints_AOS (VectType &xyz_inout) const
 
template<typename T >
long writeGridPoints_SOA (T *xyz_inout, long max_size=0) const
 
template<typename VectType >
long writeGridPoints_SOA (VectType &xyz_inout) const
 
template<typename Integer >
long writeConnectivity (Integer *connectivity_inout, ConnectivityVertexOrder whichOrder, long max_size=0) const
 
template<typename VectType >
long writeConnectivity (VectType &connectivity_inout, ConnectivityVertexOrder whichOrder) const
 
template<typename Integer >
long writeOffsetsCells (Integer *offsets_inout, long max_size=0) const
 
template<typename VectType >
long writeOffsetsCells (VectType &offsets_inout) const
 
template<typename Integer >
long writeCellTypes (Integer *types_inout, long max_size=0) const
 
template<typename VectType >
long writeCellTypes (VectType &types_inout) const
 
std::string getPartitionTypeString () const
 
Dune::PartitionSet< partitions > getPartition (void)
 
void printGridDetails (std::ostream &outstr) const
 
int getNCells () const
 
int getNVertices () const
 
int getNCorners () const
 
std::string getError () const
 
void clearError ()
 
bool hasError () const
 

Protected Attributes

GridView gridView_
 
Dune::PartitionSet< partitions > dunePartition_
 
unsigned int partition_value_
 
int ncells_
 
int nvertices_
 
int ncorners_
 
int dimw_
 

Constructor & Destructor Documentation

◆ SimMeshDataAccessor()

template<class GridView , unsigned int partitions>
Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::SimMeshDataAccessor ( const GridView &  gridView,
Dune::PartitionSet< partitions >  dunePartition 
)
explicit

Construct a SimMeshDataAccessor working on a specific GridView and specialize to a Dune::PartitionSet<>.

Parameters
gridViewThe gridView
PartitionSet<>the set of cells from which to extract geometric data

The PartitionSet of the data can be specified from one of: Dune::Partitions::all Dune::Partitions::interior Dune::Partitions::border Dune::Partitions::overlap Dune::Partitions::front Dune::Partitions::ghost Dune::Partitions::interiorBorder Dune::Partitions::interiorBorderOverlap Dune::Partitions::interiorBorderOverlapFront Dune::Partitions::all

N.B. To visualise 'field' data on the extracted grid mesh then the field variable should contain at least as many vlaues as the mesh has cells (ncells_) or vertices (nvertices_) depending on if data is cell centred or vertex centred, respectively.

As we are templated on the Dune::PartitionSet<partitions>, values for ncorners_, nvertices_ and ncells_ cannot change

This class does not work with grids containing polyhedral cells (well, it has not been tested with this kind of grid data). The user should call polyhedralCellPresent() to test if polyhedral cells are present and decide what they want to do before copying data using the data accessor methods.

References Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::countEntities(), Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::dimw_, and Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::partition_value_.

Member Function Documentation

◆ clearError()

template<class GridView , unsigned int partitions>
void Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::clearError ( )
inline

◆ countEntities()

template<class GridView , unsigned int partitions>
void Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::countEntities

Count the vertices, cells and corners.

Count all the vertices ( the Dune::Partitions::all partition ) as then we do not need to renumber the vertices as all the subsets use references to the full set.

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::SimMeshDataAccessor().

◆ getError()

template<class GridView , unsigned int partitions>
std::string Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getError ( ) const
inline

◆ getNCells()

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNCells ( ) const
inline

References Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::ncells_.

◆ getNCorners()

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNCorners ( ) const
inline

References Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::ncorners_.

◆ getNVertices()

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNVertices ( ) const
inline

References Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::nvertices_.

◆ getPartition()

template<class GridView , unsigned int partitions>
Dune::PartitionSet< partitions > Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getPartition ( void  )
inline

References Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::dunePartition_.

◆ getPartitionTypeString()

template<class GridView , unsigned int partitions>
std::string Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getPartitionTypeString

◆ hasError()

template<class GridView , unsigned int partitions>
bool Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::hasError ( ) const
inline

◆ polyhedralCellPresent()

template<class GridView , unsigned int partitions>
bool Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::polyhedralCellPresent

Checks for cells that have polyhedral type within the current partition of cells

Returns true if a polyhedral sell is found. If this is the case then this partition is not going to be available for visualisation as this class does not yet handle polyhedral cells.

◆ printGridDetails()

template<class GridView , unsigned int partitions>
void Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::printGridDetails ( std::ostream &  outstr) const

◆ writeCellTypes() [1/2]

template<class GridView , unsigned int partitions>
template<typename Integer >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeCellTypes ( Integer *  types_inout,
long  max_size = 0 
) const

Write the cell types values - directly to the pointer given in parameter 1

Parameters
types_inoutis the array to be filled with the cell types (VTK defined values)
max_sizeis used to check that the space available in the input pointer parameter will fit the number of cell offset values written.

Returns number of cells type values written

References Opm::to_string().

◆ writeCellTypes() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeCellTypes ( VectType &  types_inout) const

Write the cell types values - directly to the VectType object given in parameter 1

Parameters
types_inoutis the array to be filled with the cell types (VTK defined values) The object VectType must have a size() and data() method (e.g. a std::vector<T>)

Returns number of cells type values written

References Opm::to_string().

◆ writeConnectivity() [1/2]

template<class GridView , unsigned int partitions>
template<typename Integer >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeConnectivity ( Integer *  connectivity_inout,
ConnectivityVertexOrder  whichOrder,
long  max_size = 0 
) const

Write the connectivity array - directly to the pointer given in parameter 1 Reorders the indices as selected either in DUNE order or VTK order.

Parameters
connectivity_inoutis the array to be filled with connectivity indexes (i.e. the index into the vertex array)
whichOrder,isthe order that verticies are traversed to create a cell (VTK or DUNE)
max_sizeis used to check that the space available in the input pointer parameter will fit the number of corner values written. Returns the number of corner indices written.

References Opm::GridDataOutput::DUNE, and Opm::to_string().

◆ writeConnectivity() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeConnectivity ( VectType &  connectivity_inout,
ConnectivityVertexOrder  whichOrder 
) const

Write the connectivity array - directly to a VectType object given in parameter 1 Reorders the indices as selected either in DUNE order or VTK order.

Parameters
connectivity_inoutis the array to be filled with connectivity indexes (i.e. the index into the vertex array) The object VectType must have a size() and data() method (e.g. a std::vector<T>)
whichOrder,isthe order that verticies are traversed to create a cell (VTK or DUNE)
max_sizeis used to check that the space available in the input pointer parameter will fit the number of corner values written. Returns the number of corner indices written.

References Opm::GridDataOutput::DUNE, and Opm::to_string().

◆ writeGridPoints() [1/2]

template<class GridView , unsigned int partitions>
template<typename T >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints ( T *  x_inout,
T *  y_inout,
T *  z_inout,
long  max_size = 0 
) const

Write the positions of vertices - directly to the pointers given in parameters

Parameters
x_inoutto be filled with x coordinate verticies
y_inoutto be filled with y coordinate verticies
y_inoutto be filled with z coordinate verticies
max_sizethe maximum number of elements of type T that can be written to the input pointer memory regions.

Returns the number of vertices written

References Opm::to_string().

◆ writeGridPoints() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints ( VectType &  x_inout,
VectType &  y_inout,
VectType &  z_inout 
) const

Write the positions of vertices - directly to the pointers given in parameters

Parameters
x_inoutto be filled with x coordinate verticies
y_inoutto be filled with y coordinate verticies
y_inoutto be filled with z coordinate verticies

All parameters must have a size() and data() method (e.g. a std::vector<T>) and the current size() must be big enough

Returns the number of vertices written

References Opm::to_string().

◆ writeGridPoints_AOS() [1/2]

template<class GridView , unsigned int partitions>
template<typename T >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints_AOS ( T *  xyz_inout,
long  max_size = 0 
) const

Write the positions of vertices - directly to the pointers given in parameters as Array of Structures x,y,z,x,y,z,x,y,z,...

Parameters
xyz_inoutis the array to be filled with x,y,z coordinate verticies.
max_sizeis the maximum number x,y,z structures with elements of type T that can be written to the input pointer memory regions.

Returns the number of vertices written

References Opm::to_string().

◆ writeGridPoints_AOS() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints_AOS ( VectType &  xyz_inout) const

Write the positions of vertices - directly to the pointers given in parameters as Array of Structures x,y,z,x,y,z,x,y,z,...

Parameters
xyz_inoutis the array to be filled with x,y,z coordinate verticies. The object VectType must have a size() and data() method (e.g. a std::vector<T>)

Returns the number of vertices written

References Opm::to_string().

◆ writeGridPoints_SOA() [1/2]

template<class GridView , unsigned int partitions>
template<typename T >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints_SOA ( T *  xyz_inout,
long  max_size = 0 
) const

Write the positions of vertices - directly to the pointers given in parameters as Structure of Arrays: x,x,x,...,y,y,y,...,z,z,z,...

Parameters
xyz_inoutis the array to be filled with x,y,z coordinate verticies.
max_sizenumber of verticies (x,...y,...z,... structures) with elements of type T that can be written to the input pointer memory regions.

Returns the number of vertices written

References Opm::to_string().

◆ writeGridPoints_SOA() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeGridPoints_SOA ( VectType &  xyz_inout) const

Write the positions of vertices - directly to the pointers given in parameters as Structure of Arrays: x,x,x,...,y,y,y,...,z,z,z,...

Parameters
xyz_inoutis the array to be filled with x,y,z coordinate verticies. The object VectType must have a size() and data() method (e.g. a std::vector<T>)

Returns the number of vertices written

References Opm::to_string().

◆ writeOffsetsCells() [1/2]

template<class GridView , unsigned int partitions>
template<typename Integer >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeOffsetsCells ( Integer *  offsets_inout,
long  max_size = 0 
) const

Write the offsets values - directly to the pointer given in parameter 1

Parameters
offsets_inoutis the array to be filled with offsets into the connectivity array (i.e. the index into the connectivity array to determine the vertices used for the particular cell)
max_sizeis used to check that the space available in the input pointer parameter will fit the number of cell offset values written.

Returns number of offset values written + 1

References Opm::to_string().

◆ writeOffsetsCells() [2/2]

template<class GridView , unsigned int partitions>
template<typename VectType >
long Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::writeOffsetsCells ( VectType &  offsets_inout) const

Write the offsets values - directly to a VectType object given in parameter 1

Parameters
offsets_inoutis the array to be filled with offsets into the connectivity array (i.e. the index into the connectivity array to determine the vertices used for the particular cell). The object VectType must have a size() and data() method (e.g. a std::vector<T>)

Returns number of offset values written + 1

References Opm::to_string().

Member Data Documentation

◆ dimw_

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::dimw_
protected

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::SimMeshDataAccessor().

◆ dunePartition_

template<class GridView , unsigned int partitions>
Dune::PartitionSet<partitions> Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::dunePartition_
protected

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getPartition().

◆ gridView_

template<class GridView , unsigned int partitions>
GridView Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::gridView_
protected

◆ ncells_

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::ncells_
protected

Current partition grid information

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNCells().

◆ ncorners_

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::ncorners_
protected

Current partition grid information

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNCorners().

◆ nvertices_

template<class GridView , unsigned int partitions>
int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::nvertices_
protected

Current partition grid information

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::getNVertices().

◆ partition_value_

template<class GridView , unsigned int partitions>
unsigned int Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::partition_value_
protected

Referenced by Opm::GridDataOutput::SimMeshDataAccessor< GridView, partitions >::SimMeshDataAccessor().

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