Dune::dgf::GridParameterBlock Class Reference

Common Grid parameters. More...

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

Inheritance diagram for Dune::dgf::GridParameterBlock:

Public Types
typedef unsigned int	Flags

Public Member Functions
	GridParameterBlock (std::istream &in)
	constructor: read common 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	bisectionCompatibility () const
	returns true if grid is compatible for bisection refinement
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
static const Flags	foundCompatible = 1 << 13

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_
bool	bisectionCompatibility_
std::stringstream	line

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

Flags

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

Constructor & Destructor Documentation

GridParameterBlock()

Dune::dgf::GridParameterBlock::GridParameterBlock

(

std::istream &

in

)

constructor: read common parameters

Member Function Documentation

bisectionCompatibility()

bool Dune::dgf::GridParameterBlock::bisectionCompatibility ( ) const

inline

returns true if grid is compatible for bisection refinement

dumpFileName()

const std::string & Dune::dgf::GridParameterBlock::dumpFileName ( ) const

inline

findtoken()

bool Dune::dgf::BasicBlock::findtoken ( std ::string  token )

protectedinherited

getnextentry()

template<class ENTRY >

bool Dune::dgf::BasicBlock::getnextentry ( ENTRY &  entry )

inlineprotectedinherited

getnextline()

bool Dune::dgf::BasicBlock::getnextline ( )

protectedinherited

gettokenparam()

bool Dune::dgf::BasicBlock::gettokenparam ( std ::string  token, std ::string &  entry  )

protectedinherited

id()

const std::string & Dune::dgf::BasicBlock::id ( ) const

inlineinherited

isactive()

bool Dune::dgf::BasicBlock::isactive ( )

inlineinherited

isempty()

bool Dune::dgf::BasicBlock::isempty ( )

inlineinherited

linenumber()

int Dune::dgf::BasicBlock::linenumber ( )

inlineinherited

markLongestEdge()

bool Dune::dgf::GridParameterBlock::markLongestEdge ( ) const

inline

returns true if longest edge should be marked for AlbertaGrid

name()

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

inline

return the name of the grid

noflines()

int & Dune::dgf::BasicBlock::noflines ( )

inlineinherited

ok()

bool Dune::dgf::GridParameterBlock::ok ( )

inline

reset()

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

inlineprotectedinherited

Member Data Documentation

bisectionCompatibility_

bool Dune::dgf::GridParameterBlock::bisectionCompatibility_

protected

dumpFileName_

std::string Dune::dgf::GridParameterBlock::dumpFileName_

protected

foundCompatible

const Flags Dune::dgf::GridParameterBlock::foundCompatible = 1 << 13

static

foundDumpFileName

const Flags Dune::dgf::GridParameterBlock::foundDumpFileName = 1 << 1

static

foundFlags_

Flags Dune::dgf::GridParameterBlock::foundFlags_

protected

foundLongestEdge

const Flags Dune::dgf::GridParameterBlock::foundLongestEdge = 1 << 5

static

foundName

const Flags Dune::dgf::GridParameterBlock::foundName = 1 << 0

static

line

std::stringstream Dune::dgf::BasicBlock::line

protectedinherited

markLongestEdge_

bool Dune::dgf::GridParameterBlock::markLongestEdge_

protected

name_

std::string Dune::dgf::GridParameterBlock::name_

protected

---

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

• gridparameter.hh