dune-grid  2.1.1
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends
Dune::dgf::GridParameterBlock Class Reference

Common Grid parametersFor each grid implementation there is a set of parameters that can be passed via the GridParameter block to the momment of grid construction. Currently implemented common parameters are:

1. name: The name of the grid ( later returned by the method grid.name() ).
2. refinementedge: parameter to specify the refinement edge in simplices. Valid values are arbitrary (which is the default value) and longest which marks the longest edge/face of each simplex to be the refinement edge.
See also the examplegrid5.dgf file for examples. More...

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

Inheritance diagram for Dune::dgf::GridParameterBlock:
Inheritance graph

List of all members.

Public Types

typedef unsigned int Flags

Public Member Functions

 GridParameterBlock (std::istream &in)
 constructor: read commmon parameters
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 ()

Static Public Attributes

static const Flags foundName = 1 << 0
static const Flags foundDumpFileName = 1 << 1
static const Flags foundLongestEdge = 1 << 5
static const char * ID = "GridParameter"

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

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

Friends

std::ostream & operator<< (std::ostream &os, const BasicBlock &b)

Detailed Description

Common Grid parameters

For each grid implementation there is a set of parameters that can be passed via the GridParameter block to the momment of grid construction. Currently implemented common parameters are:

1. name: The name of the grid ( later returned by the method grid.name() ).
2. refinementedge: parameter to specify the refinement edge in simplices. Valid values are arbitrary (which is the default value) and longest which marks the longest edge/face of each simplex to be the refinement edge.
See also the examplegrid5.dgf file for examples.


Member Typedef Documentation


Constructor & Destructor Documentation

Dune::dgf::GridParameterBlock::GridParameterBlock ( std::istream &  in)

Member Function Documentation

const std::string& Dune::dgf::GridParameterBlock::dumpFileName ( ) const [inline]
bool Dune::dgf::BasicBlock::findtoken ( std::string  token) [protected, inherited]
template<class ENTRY >
bool Dune::dgf::BasicBlock::getnextentry ( ENTRY &  entry) [inline, protected, inherited]
bool Dune::dgf::BasicBlock::getnextline ( ) [protected, inherited]
bool Dune::dgf::BasicBlock::gettokenparam ( std::string  token,
std::string &  entry 
) [protected, inherited]
bool Dune::dgf::BasicBlock::isactive ( ) [inline, inherited]
bool Dune::dgf::BasicBlock::isempty ( ) [inline, inherited]
int Dune::dgf::BasicBlock::linenumber ( ) [inline, inherited]

returns true if longest edge should be marked for AlbertaGrid

References foundFlags_, foundLongestEdge, and markLongestEdge_.

const std::string& Dune::dgf::GridParameterBlock::name ( const std::string &  defaultValue) const [inline]

return the name of the grid

References foundFlags_, foundName, and name_.

int& Dune::dgf::BasicBlock::noflines ( ) [inline, inherited]
void Dune::dgf::BasicBlock::reset ( ) [inline, protected, inherited]

Friends And Related Function Documentation

std :: ostream& operator<< ( std::ostream &  os,
const BasicBlock b 
) [friend, inherited]

Member Data Documentation

Referenced by dumpFileName(), and GridParameterBlock().

Referenced by dumpFileName(), and GridParameterBlock().

Referenced by GridParameterBlock(), and name().

const char * Dune::dgf::GridParameterBlock::ID = "GridParameter" [static]
std::stringstream Dune::dgf::BasicBlock::line [protected, inherited]
std::string Dune::dgf::GridParameterBlock::name_ [protected]

Referenced by GridParameterBlock(), and name().


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