dune-foamgrid  2.7-git
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > > Struct Template Reference

#include <dune/foamgrid/dgffoam.hh>

Public Types

typedef FoamGrid< dim, dimworld, ctype > Grid
 grid type More...
 
typedef MPIHelper::MPICommunicator MPICommunicatorType
 MPI communicator type. More...
 

Public Member Functions

 DGFGridFactory (std::istream &input, MPICommunicatorType comm=MPIHelper::getCommunicator())
 constructor taking istream More...
 
 DGFGridFactory (const std::string &filename, MPICommunicatorType comm=MPIHelper::getCommunicator())
 constructor taking filename More...
 
Gridgrid ()
 return grid More...
 
template<class GG , class II >
bool wasInserted (const Dune::Intersection< GG, II > &intersection) const
 please doc me More...
 
template<class GG , class II >
int boundaryId (const Dune::Intersection< GG, II > &intersection) const
 will return boundary segment index More...
 
template<int codim>
int numParameters () const
 return number of parameters More...
 
template<class Entity >
int numParameters (const Entity &) const
 return number of parameters More...
 
std::vector< double > & parameter (const typename Grid::template Codim< 0 >::Entity &element)
 return parameter for codim 0 entity More...
 
std::vector< double > & parameter (const typename Grid::template Codim< dimension >::Entity &vertex)
 return parameter for vertex More...
 
bool haveBoundaryParameters () const
 FoamGrid does not support boundary parameters. More...
 
template<class GG , class II >
const DGFBoundaryParameter::type & boundaryParameter (const Dune::Intersection< GG, II > &intersection) const
 return invalid value More...
 

Static Public Attributes

static const int dimension = dim
 grid dimension More...
 
static const int dimensionWorld = dimworld
 gridWorld dimension More...
 

Member Typedef Documentation

◆ Grid

template<int dim, int dimworld, class ctype >
typedef FoamGrid< dim, dimworld, ctype > Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::Grid

grid type

◆ MPICommunicatorType

template<int dim, int dimworld, class ctype >
typedef MPIHelper::MPICommunicator Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::MPICommunicatorType

MPI communicator type.

Constructor & Destructor Documentation

◆ DGFGridFactory() [1/2]

template<int dim, int dimworld, class ctype >
Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::DGFGridFactory ( std::istream &  input,
MPICommunicatorType  comm = MPIHelper::getCommunicator() 
)
inlineexplicit

constructor taking istream

◆ DGFGridFactory() [2/2]

template<int dim, int dimworld, class ctype >
Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::DGFGridFactory ( const std::string &  filename,
MPICommunicatorType  comm = MPIHelper::getCommunicator() 
)
inlineexplicit

constructor taking filename

Member Function Documentation

◆ boundaryId()

template<int dim, int dimworld, class ctype >
template<class GG , class II >
int Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::boundaryId ( const Dune::Intersection< GG, II > &  intersection) const
inline

will return boundary segment index

◆ boundaryParameter()

template<int dim, int dimworld, class ctype >
template<class GG , class II >
const DGFBoundaryParameter::type& Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::boundaryParameter ( const Dune::Intersection< GG, II > &  intersection) const
inline

return invalid value

◆ grid()

template<int dim, int dimworld, class ctype >
Grid* Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::grid ( )
inline

return grid

◆ haveBoundaryParameters()

template<int dim, int dimworld, class ctype >
bool Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::haveBoundaryParameters ( ) const
inline

FoamGrid does not support boundary parameters.

◆ numParameters() [1/2]

template<int dim, int dimworld, class ctype >
template<int codim>
int Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::numParameters ( ) const
inline

return number of parameters

◆ numParameters() [2/2]

template<int dim, int dimworld, class ctype >
template<class Entity >
int Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::numParameters ( const Entity &  ) const
inline

return number of parameters

◆ parameter() [1/2]

template<int dim, int dimworld, class ctype >
std::vector< double >& Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::parameter ( const typename Grid::template Codim< 0 >::Entity &  element)
inline

return parameter for codim 0 entity

◆ parameter() [2/2]

template<int dim, int dimworld, class ctype >
std::vector< double >& Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::parameter ( const typename Grid::template Codim< dimension >::Entity &  vertex)
inline

return parameter for vertex

◆ wasInserted()

template<int dim, int dimworld, class ctype >
template<class GG , class II >
bool Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::wasInserted ( const Dune::Intersection< GG, II > &  intersection) const
inline

please doc me

Member Data Documentation

◆ dimension

template<int dim, int dimworld, class ctype >
const int Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::dimension = dim
static

grid dimension

◆ dimensionWorld

template<int dim, int dimworld, class ctype >
const int Dune::DGFGridFactory< FoamGrid< dim, dimworld, ctype > >::dimensionWorld = dimworld
static

gridWorld dimension


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