3.1-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::VariableClass< TypeTag > Class Template Reference

Base class holding the variables and discretized data for sequential models. More...

#include <dumux/porousmediumflow/sequential/variableclass.hh>

Inheritance diagram for Dumux::VariableClass< TypeTag >:
Inheritance graph

Description

template<class TypeTag>
class Dumux::VariableClass< TypeTag >

Base class holding the variables and discretized data for sequential models.

Stores global information and variables that are common for all sequential models and also functions needed to access these variables. Can be directly used for a single phase model.

Template Parameters
TypeTagThe Type Tag

Public Types

using CellDataVector = typename std::vector< CellData >
 

Public Member Functions

 VariableClass (const GridView &gridView)
 Constructs a VariableClass object. More...
 
void initialize ()
 Initializes the variable class. More...
 
void adaptVariableSize (const int size)
 Resizes sequential variable vectors. More...
 
CellDataVectorcellDataGlobal ()
 Return the vector holding all cell data. More...
 
const CellDataVectorcellDataGlobal () const
 
CellData & cellData (const int idx)
 Return the cell data of a specific cell. More...
 
const CellData & cellData (const int idx) const
 
int index (const Element &element) const
 Get index of element (codim 0 entity) More...
 
int index (const Vertex &vertex) const
 Get index of vertex (codim dim entity) More...
 
const GridView & gridView () const
 Return gridView. More...
 
ElementMapper & elementMapper ()
 Return mapper for elements (for adaptive grids) More...
 
const ElementMapper & elementMapper () const
 Return mapper for elements (for static grids) More...
 
VertexMapper & vertexMapper ()
 Return mapper for vertices (for adaptive grids) More...
 
const VertexMapper & vertexMapper () const
 Return mapper for vertices (for static grids) More...
 

Member Typedef Documentation

◆ CellDataVector

template<class TypeTag >
using Dumux::VariableClass< TypeTag >::CellDataVector = typename std::vector<CellData>

Constructor & Destructor Documentation

◆ VariableClass()

template<class TypeTag >
Dumux::VariableClass< TypeTag >::VariableClass ( const GridView &  gridView)
inline

Constructs a VariableClass object.

Parameters
gridViewa DUNE gridview object corresponding to diffusion and transport equation

Member Function Documentation

◆ adaptVariableSize()

template<class TypeTag >
void Dumux::VariableClass< TypeTag >::adaptVariableSize ( const int  size)
inline

Resizes sequential variable vectors.

Method that change the size of the vectors for h-adaptive simulations.

Parameters
sizeSize of the current (refined and coarsened) grid

◆ cellData() [1/2]

template<class TypeTag >
CellData & Dumux::VariableClass< TypeTag >::cellData ( const int  idx)
inline

Return the cell data of a specific cell.

◆ cellData() [2/2]

template<class TypeTag >
const CellData & Dumux::VariableClass< TypeTag >::cellData ( const int  idx) const
inline

◆ cellDataGlobal() [1/2]

template<class TypeTag >
CellDataVector & Dumux::VariableClass< TypeTag >::cellDataGlobal ( )
inline

Return the vector holding all cell data.

◆ cellDataGlobal() [2/2]

template<class TypeTag >
const CellDataVector & Dumux::VariableClass< TypeTag >::cellDataGlobal ( ) const
inline

◆ elementMapper() [1/2]

template<class TypeTag >
ElementMapper & Dumux::VariableClass< TypeTag >::elementMapper ( )
inline

Return mapper for elements (for adaptive grids)

◆ elementMapper() [2/2]

template<class TypeTag >
const ElementMapper & Dumux::VariableClass< TypeTag >::elementMapper ( ) const
inline

Return mapper for elements (for static grids)

◆ gridView()

template<class TypeTag >
const GridView & Dumux::VariableClass< TypeTag >::gridView ( ) const
inline

Return gridView.

◆ index() [1/2]

template<class TypeTag >
int Dumux::VariableClass< TypeTag >::index ( const Element &  element) const
inline

Get index of element (codim 0 entity)

Get index of element (codim 0 entity).

Parameters
elementcodim 0 entity
Returns
element index

◆ index() [2/2]

template<class TypeTag >
int Dumux::VariableClass< TypeTag >::index ( const Vertex &  vertex) const
inline

Get index of vertex (codim dim entity)

Get index of vertex (codim dim entity).

Parameters
vertexcodim dim entity
Returns
vertex index

◆ initialize()

template<class TypeTag >
void Dumux::VariableClass< TypeTag >::initialize ( )
inline

Initializes the variable class.

Method initializes the cellData vector. Should be called from problem init()

◆ vertexMapper() [1/2]

template<class TypeTag >
VertexMapper & Dumux::VariableClass< TypeTag >::vertexMapper ( )
inline

Return mapper for vertices (for adaptive grids)

◆ vertexMapper() [2/2]

template<class TypeTag >
const VertexMapper & Dumux::VariableClass< TypeTag >::vertexMapper ( ) const
inline

Return mapper for vertices (for static grids)


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