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

Grid parameters for UGGrid. More...

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

Inheritance diagram for Dune::dgf::UGGridParameterBlock:
Inheritance graph

List of all members.

Public Types

typedef unsigned int Flags

Public Member Functions

 UGGridParameterBlock (std::istream &in)
 constructor taking istream
bool noClosure () const
 returns true if no closure should be used for UGGrid
bool noCopy () const
 returns true if no copies are made for UGGrid elements
size_t heapSize () const
 returns heap size used on construction of the grid
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

bool _noClosure
bool _noCopy
size_t _heapsize
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

Grid parameters for UGGrid.

The UGGridParameter class is in charge of passing UGGrid specific parameters to grid construction. Current parameters are:

1. closure:(valid values are none or green, which is the default value) will set the closure type of the returned UGGrid.
2. copies: (valid values are yes or none, which is the default value) will enforce that non-refined element are copied to the next level on refinement of a UGGrid.
3. heapsize: set heap size for UGGrid (default value is 500 MB).
See the examplegrid5.dgf file for an example.


Member Typedef Documentation

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

Constructor & Destructor Documentation


Member Function Documentation

const std::string& Dune::dgf::GridParameterBlock::dumpFileName ( ) const [inline, inherited]
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]
size_t Dune::dgf::UGGridParameterBlock::heapSize ( ) const [inline]

returns heap size used on construction of the grid

References _heapsize.

bool Dune::dgf::BasicBlock::isactive ( ) [inline, inherited]
bool Dune::dgf::BasicBlock::isempty ( ) [inline, inherited]
int Dune::dgf::BasicBlock::linenumber ( ) [inline, inherited]
bool Dune::dgf::GridParameterBlock::markLongestEdge ( ) const [inline, inherited]
const std::string& Dune::dgf::GridParameterBlock::name ( const std::string &  defaultValue) const [inline, inherited]

returns true if no closure should be used for UGGrid

References _noClosure.

bool Dune::dgf::UGGridParameterBlock::noCopy ( ) const [inline]

returns true if no copies are made for UGGrid elements

References _noCopy.

int& Dune::dgf::BasicBlock::noflines ( ) [inline, inherited]
bool Dune::dgf::GridParameterBlock::ok ( ) [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 heapSize(), and UGGridParameterBlock().

Referenced by noClosure(), and UGGridParameterBlock().

Referenced by noCopy(), and UGGridParameterBlock().

std::string Dune::dgf::GridParameterBlock::dumpFileName_ [protected, inherited]
const Flags Dune::dgf::GridParameterBlock::foundDumpFileName = 1 << 1 [static, inherited]
const Flags Dune::dgf::GridParameterBlock::foundLongestEdge = 1 << 5 [static, inherited]
const Flags Dune::dgf::GridParameterBlock::foundName = 1 << 0 [static, inherited]
const char * Dune::dgf::GridParameterBlock::ID = "GridParameter" [static, inherited]
std::stringstream Dune::dgf::BasicBlock::line [protected, inherited]
std::string Dune::dgf::GridParameterBlock::name_ [protected, inherited]

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