Opm::CubeGridVanguard< TypeTag > Class Template Reference

Provides a simulator vanguad which creates a regular grid made of quadrilaterals. More...

#include <cubegridvanguard.hh>

Inheritance diagram for Opm::CubeGridVanguard< TypeTag >:

Public Member Functions
	CubeGridVanguard (Simulator &simulator)
	Create the grid. More...
Grid &	grid ()
	Returns a reference to the grid. More...
const Grid &	grid () const
	Returns a reference to the grid. More...
const GridView &	gridView () const
	Returns a reference to the grid view to be used. More...
int	gridSequenceNumber () const
	Returns the number of times the grid has been changed since its creation. More...
void	loadBalance ()
	Distribute the grid (and attached data) over all processes. More...

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the simulator vanguad. More...

Protected Member Functions
void	finalizeInit_ ()
void	updateGridView_ ()

Protected Attributes
GridPointer	cubeGrid_

Detailed Description

template<class TypeTag>
class Opm::CubeGridVanguard< TypeTag >

Provides a simulator vanguad which creates a regular grid made of quadrilaterals.

A quadrilateral is a line segment in 1D, a rectangle in 2D and a cube in 3D.

Constructor & Destructor Documentation

CubeGridVanguard()

template<class TypeTag >

Opm::CubeGridVanguard< TypeTag >::CubeGridVanguard ( Simulator &  simulator )

inline

Create the grid.

References Opm::CubeGridVanguard< TypeTag >::cubeGrid_, and Opm::BaseVanguard< TypeTag >::finalizeInit_().

Member Function Documentation

finalizeInit_()

template<class TypeTag >

void Opm::BaseVanguard< TypeTag >::finalizeInit_ ( )

inlineprotectedinherited

References Opm::BaseVanguard< TypeTag >::updateGridView_().

Referenced by Opm::CubeGridVanguard< TypeTag >::CubeGridVanguard(), Opm::DgfVanguard< TypeTag >::DgfVanguard(), Opm::StructuredGridVanguard< TypeTag >::StructuredGridVanguard(), and Opm::UnstructuredGridVanguard< TypeTag >::UnstructuredGridVanguard().

grid() [1/2]

template<class TypeTag >

Grid & Opm::CubeGridVanguard< TypeTag >::grid ( )

inline

Returns a reference to the grid.

References Opm::CubeGridVanguard< TypeTag >::cubeGrid_.

grid() [2/2]

template<class TypeTag >

const Grid & Opm::CubeGridVanguard< TypeTag >::grid ( ) const

inline

Returns a reference to the grid.

References Opm::CubeGridVanguard< TypeTag >::cubeGrid_.

gridSequenceNumber()

template<class TypeTag >

int Opm::BaseVanguard< TypeTag >::gridSequenceNumber ( ) const

inlineinherited

Returns the number of times the grid has been changed since its creation.

This basically says how often the grid has been adapted in the current simulation run.

gridView()

template<class TypeTag >

const GridView & Opm::BaseVanguard< TypeTag >::gridView ( ) const

inlineinherited

Returns a reference to the grid view to be used.

Referenced by Opm::DgfVanguard< TypeTag >::addFractures_().

loadBalance()

template<class TypeTag >

void Opm::BaseVanguard< TypeTag >::loadBalance ( )

inlineinherited

Distribute the grid (and attached data) over all processes.

References Opm::BaseVanguard< TypeTag >::updateGridView_().

registerParameters()

template<class TypeTag >

static void Opm::CubeGridVanguard< TypeTag >::registerParameters ( )

inlinestatic

Register all run-time parameters for the simulator vanguad.

updateGridView_()

template<class TypeTag >

void Opm::BaseVanguard< TypeTag >::updateGridView_ ( )

inlineprotectedinherited

Referenced by Opm::BaseVanguard< TypeTag >::finalizeInit_(), and Opm::BaseVanguard< TypeTag >::loadBalance().

Member Data Documentation

cubeGrid_

template<class TypeTag >

GridPointer Opm::CubeGridVanguard< TypeTag >::cubeGrid_

protected

Referenced by Opm::CubeGridVanguard< TypeTag >::CubeGridVanguard(), and Opm::CubeGridVanguard< TypeTag >::grid().

---

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

• cubegridvanguard.hh