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::MultiDomainFVGridGeometry< MDTraits > Class Template Reference

A multidomain wrapper for multiple grid geometries. More...

#include <dumux/multidomain/fvgridgeometry.hh>

Description

template<class MDTraits>
class Dumux::MultiDomainFVGridGeometry< MDTraits >

A multidomain wrapper for multiple grid geometries.

Template Parameters
MDTraitsThe multidomain traits

Public Types

template<std::size_t i>
using Type = typename MDTraits::template SubDomain< i >::GridGeometry
 export base types of the stored type More...
 
template<std::size_t i>
using PtrType = std::shared_ptr< Type< i > >
 export pointer types the stored type More...
 
using TupleType = typename MDTraits::template Tuple< PtrType >
 export type of tuple of pointers More...
 

Public Member Functions

 MultiDomainFVGridGeometry ()=default
 The default constructor. More...
 
template<class GridViews >
 MultiDomainFVGridGeometry (GridViews &&gridViews)
 Contruct the problem. More...
 
void update ()
 Update all grid geometries (do this again after grid adaption) More...
 
template<std::size_t i>
const Type< i > & operator[] (Dune::index_constant< i > id) const
 return the grid geometry for domain with index i More...
 
template<std::size_t i>
Type< i > & operator[] (Dune::index_constant< i > id)
 return the grid geometry for domain with index i More...
 
template<std::size_t i>
PtrType< i > get (Dune::index_constant< i > id=Dune::index_constant< i >{})
 ! return the grid geometry pointer for domain with index i More...
 
template<std::size_t i>
void set (PtrType< i > p, Dune::index_constant< i > id=Dune::index_constant< i >{})
 set the pointer for sub domain i More...
 
TupleType getTuple ()
 return the grid variables tuple we are wrapping More...
 

Member Typedef Documentation

◆ PtrType

template<class MDTraits >
template<std::size_t i>
using Dumux::MultiDomainFVGridGeometry< MDTraits >::PtrType = std::shared_ptr<Type<i> >

export pointer types the stored type

◆ TupleType

template<class MDTraits >
using Dumux::MultiDomainFVGridGeometry< MDTraits >::TupleType = typename MDTraits::template Tuple<PtrType>

export type of tuple of pointers

◆ Type

template<class MDTraits >
template<std::size_t i>
using Dumux::MultiDomainFVGridGeometry< MDTraits >::Type = typename MDTraits::template SubDomain<i>::GridGeometry

export base types of the stored type

Constructor & Destructor Documentation

◆ MultiDomainFVGridGeometry() [1/2]

template<class MDTraits >
Dumux::MultiDomainFVGridGeometry< MDTraits >::MultiDomainFVGridGeometry ( )
default

The default constructor.

◆ MultiDomainFVGridGeometry() [2/2]

template<class MDTraits >
template<class GridViews >
Dumux::MultiDomainFVGridGeometry< MDTraits >::MultiDomainFVGridGeometry ( GridViews &&  gridViews)
inline

Contruct the problem.

Parameters
gridViewsa tuple of gridViews

Member Function Documentation

◆ get()

template<class MDTraits >
template<std::size_t i>
PtrType< i > Dumux::MultiDomainFVGridGeometry< MDTraits >::get ( Dune::index_constant< i >  id = Dune::index_constant<i>{})
inline

! return the grid geometry pointer for domain with index i

◆ getTuple()

template<class MDTraits >
TupleType Dumux::MultiDomainFVGridGeometry< MDTraits >::getTuple ( )
inline

return the grid variables tuple we are wrapping

Note
the copy is not expensive since it is a tuple of shared pointers

◆ operator[]() [1/2]

template<class MDTraits >
template<std::size_t i>
Type< i > & Dumux::MultiDomainFVGridGeometry< MDTraits >::operator[] ( Dune::index_constant< i >  id)
inline

return the grid geometry for domain with index i

◆ operator[]() [2/2]

template<class MDTraits >
template<std::size_t i>
const Type< i > & Dumux::MultiDomainFVGridGeometry< MDTraits >::operator[] ( Dune::index_constant< i >  id) const
inline

return the grid geometry for domain with index i

◆ set()

template<class MDTraits >
template<std::size_t i>
void Dumux::MultiDomainFVGridGeometry< MDTraits >::set ( PtrType< i >  p,
Dune::index_constant< i >  id = Dune::index_constant<i>{} 
)
inline

set the pointer for sub domain i

◆ update()

template<class MDTraits >
void Dumux::MultiDomainFVGridGeometry< MDTraits >::update ( )
inline

Update all grid geometries (do this again after grid adaption)


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