dune-grid  2.2.0
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
Dune::dgf::YaspGridParameterBlock Class Reference

Grid parameters for YaspGridThe YaspGridParameter class is in charge of passing parameters specific to YaspGrid to the grid construction. Current parameters are:

  1. overlap defining the overlap of the grid (default value is zero)

See the examplegrid5.dgf file for an example. More...

#include <dune/grid/io/file/dgfparser/dgfyasp.hh>

Inheritance diagram for Dune::dgf::YaspGridParameterBlock:
Inheritance graph

List of all members.

Public Types

typedef unsigned int Flags

Public Member Functions

 YaspGridParameterBlock (std::istream &in)
 constructor taking istream
int overlap () const
 get dimension of world found in block
const std::string & name (const std::string &defaultValue) const
 return the name of the grid
const std::string & dumpFileName () const
bool markLongestEdge () const
 returns true if longest edge should be marked for AlbertaGrid
bool ok ()
bool isactive ()
bool isempty ()
int & noflines ()
int linenumber ()
const std::string & id () const

Static Public Attributes

static const Flags foundName = 1 << 0
static const Flags foundDumpFileName = 1 << 1
static const Flags foundLongestEdge = 1 << 5

Protected Member Functions

void reset ()
bool getnextline ()
template<class ENTRY >
bool getnextentry (ENTRY &entry)
bool gettokenparam (std::string token, std::string &entry)
bool findtoken (std::string token)

Protected Attributes

int _overlap
Flags foundFlags_
std::string name_
std::string dumpFileName_
bool markLongestEdge_
std::stringstream line

Detailed Description

Grid parameters for YaspGrid

The YaspGridParameter class is in charge of passing parameters specific to YaspGrid to the grid construction. Current parameters are:

  1. overlap defining the overlap of the grid (default value is zero)

See the examplegrid5.dgf file for an example.

Note:
The periodic parameter has been replaced by the PeriodicFaceTransformation block.

Member Typedef Documentation

typedef unsigned int Dune::dgf::GridParameterBlock::Flags
inherited

Constructor & Destructor Documentation

Dune::dgf::YaspGridParameterBlock::YaspGridParameterBlock ( std::istream &  in)
inline

Member Function Documentation

const std::string& Dune::dgf::GridParameterBlock::dumpFileName ( ) const
inlineinherited
bool Dune::dgf::BasicBlock::findtoken ( std::string  token)
protectedinherited
template<class ENTRY >
bool Dune::dgf::BasicBlock::getnextentry ( ENTRY &  entry)
inlineprotectedinherited
bool Dune::dgf::BasicBlock::getnextline ( )
protectedinherited
bool Dune::dgf::BasicBlock::gettokenparam ( std::string  token,
std::string &  entry 
)
protectedinherited
const std::string& Dune::dgf::BasicBlock::id ( ) const
inlineinherited
bool Dune::dgf::BasicBlock::isactive ( )
inlineinherited
bool Dune::dgf::BasicBlock::isempty ( )
inlineinherited
int Dune::dgf::BasicBlock::linenumber ( )
inlineinherited
bool Dune::dgf::GridParameterBlock::markLongestEdge ( ) const
inlineinherited
const std::string& Dune::dgf::GridParameterBlock::name ( const std::string &  defaultValue) const
inlineinherited
int& Dune::dgf::BasicBlock::noflines ( )
inlineinherited
bool Dune::dgf::GridParameterBlock::ok ( )
inlineinherited
int Dune::dgf::YaspGridParameterBlock::overlap ( ) const
inline

get dimension of world found in block

References _overlap.

void Dune::dgf::BasicBlock::reset ( )
inlineprotectedinherited

Member Data Documentation

int Dune::dgf::YaspGridParameterBlock::_overlap
protected

Referenced by overlap(), and YaspGridParameterBlock().

std::string Dune::dgf::GridParameterBlock::dumpFileName_
protectedinherited
const Flags Dune::dgf::GridParameterBlock::foundDumpFileName = 1 << 1
staticinherited
Flags Dune::dgf::GridParameterBlock::foundFlags_
protectedinherited
const Flags Dune::dgf::GridParameterBlock::foundLongestEdge = 1 << 5
staticinherited
const Flags Dune::dgf::GridParameterBlock::foundName = 1 << 0
staticinherited
std::stringstream Dune::dgf::BasicBlock::line
protectedinherited
bool Dune::dgf::GridParameterBlock::markLongestEdge_
protectedinherited
std::string Dune::dgf::GridParameterBlock::name_
protectedinherited

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