Dune::dgf::YaspGridParameterBlock Class Reference

Grid parameters for YaspGrid. More...

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

Inheritance diagram for Dune::dgf::YaspGridParameterBlock:

Public Types
typedef unsigned int	Flags

Public Member Functions
	YaspGridParameterBlock (std::istream &in)
	constructor taking istream More...
int	overlap () const
	get dimension of world found in block More...
const std::string &	name (const std::string &defaultValue) const
	return the name of the grid More...
const std::string &	dumpFileName () const
bool	markLongestEdge () const
	returns true if longest edge should be marked for AlbertaGrid More...
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

Flags

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

inherited

Constructor & Destructor Documentation

YaspGridParameterBlock()

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

inline

constructor taking istream

Member Function Documentation

dumpFileName()

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

inlineinherited

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

inlineinherited

returns true if longest edge should be marked for AlbertaGrid

name()

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

inlineinherited

return the name of the grid

noflines()

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

inlineinherited

ok()

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

inlineinherited

overlap()

int Dune::dgf::YaspGridParameterBlock::overlap ( ) const

inline

get dimension of world found in block

reset()

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

inlineprotectedinherited

Member Data Documentation

_overlap

int Dune::dgf::YaspGridParameterBlock::_overlap

protected

dumpFileName_

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

protectedinherited

foundDumpFileName

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

staticinherited

foundFlags_

Flags Dune::dgf::GridParameterBlock::foundFlags_

protectedinherited

foundLongestEdge

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

staticinherited

foundName

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

staticinherited

line

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

protectedinherited

markLongestEdge_

bool Dune::dgf::GridParameterBlock::markLongestEdge_

protectedinherited

name_

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

protectedinherited

---

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

• dgfyasp.hh