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/blocks/gridparameter.hh>

Inheritance diagram for Dune::dgf::GridParameterBlock:

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 ()
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
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

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

---

Constructor & Destructor Documentation

Dune::dgf::GridParameterBlock::GridParameterBlock

(

std::istream &

in

)

constructor: read commmon parameters

References dumpFileName_, Dune::dgf::BasicBlock::findtoken(), foundDumpFileName, foundFlags_, foundLongestEdge, foundName, Dune::dgf::BasicBlock::getnextentry(), Dune::dgf::BasicBlock::isempty(), Dune::dgf::makeupcase(), markLongestEdge_, and name_.

---

Member Function Documentation

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

(

)

const [inline]

References dumpFileName_, foundDumpFileName, and foundFlags_.

bool Dune::dgf::BasicBlock::findtoken

(

std::string

token

)

[protected, inherited]

References Dune::dgf::BasicBlock::getnextline(), Dune::dgf::makeupcase(), and Dune::dgf::BasicBlock::reset().

Referenced by Dune::dgf::BoundaryDomBlock::BoundaryDomBlock(), GridParameterBlock(), Dune::dgf::SimplexGenerationBlock::SimplexGenerationBlock(), Dune::dgf::UGGridParameterBlock::UGGridParameterBlock(), Dune::dgf::VertexBlock::VertexBlock(), and Dune::dgf::YaspGridParameterBlock::YaspGridParameterBlock().

template<class ENTRY >

bool Dune::dgf::BasicBlock::getnextentry

(

ENTRY &

entry

)

[inline, protected, inherited]

References Dune::dgf::BasicBlock::line.

Referenced by Dune::dgf::BoundaryDomBlock::BoundaryDomBlock(), GridParameterBlock(), Dune::dgf::IntervalBlock::IntervalBlock(), Dune::dgf::SimplexGenerationBlock::SimplexGenerationBlock(), Dune::dgf::UGGridParameterBlock::UGGridParameterBlock(), Dune::dgf::VertexBlock::VertexBlock(), and Dune::dgf::YaspGridParameterBlock::YaspGridParameterBlock().

bool Dune::dgf::BasicBlock::getnextline

(

)

[protected, inherited]

Referenced by Dune::dgf::DimBlock::DimBlock(), Dune::dgf::BasicBlock::findtoken(), Dune::dgf::BasicBlock::gettokenparam(), Dune::dgf::IntervalBlock::IntervalBlock(), and Dune::dgf::ProjectionBlock::ProjectionBlock().

bool Dune::dgf::BasicBlock::gettokenparam	(	std::string	token,
		std::string &	entry
	)		[protected, inherited]

References Dune::dgf::BasicBlock::getnextline(), Dune::dgf::makeupcase(), and Dune::dgf::BasicBlock::reset().

Referenced by Dune::dgf::SimplexGenerationBlock::SimplexGenerationBlock().

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

(

)

const [inline, inherited]

Referenced by Dune::dgf::BoundaryDomBlock::BoundaryDomBlock(), and Dune::dgf::VertexBlock::VertexBlock().

bool Dune::dgf::BasicBlock::isactive

(

)

[inline, inherited]

Referenced by Dune::dgf::BoundaryDomBlock::BoundaryDomBlock(), Dune::dgf::BoundarySegBlock::BoundarySegBlock(), Dune::DuneGridFormatParser::generateBoundaries(), Dune::dgf::IntervalBlock::IntervalBlock(), Dune::DuneGridFormatParser::readDuneGrid(), and Dune::dgf::VertexBlock::VertexBlock().

bool Dune::dgf::BasicBlock::isempty

(

)

[inline, inherited]

Referenced by Dune::dgf::DimBlock::DimBlock(), and GridParameterBlock().

int Dune::dgf::BasicBlock::linenumber

(

)

[inline, inherited]

bool Dune::dgf::GridParameterBlock::markLongestEdge

(

)

const [inline]

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]

Referenced by Dune::dgf::DimBlock::DimBlock(), Dune::dgf::BoundarySegBlock::nofbound(), Dune::dgf::CubeBlock::nofsimplex(), and Dune::dgf::SimplexBlock::nofsimplex().

bool Dune::dgf::GridParameterBlock::ok

(

)

[inline]

void Dune::dgf::BasicBlock::reset

(

)

[inline, protected, inherited]

Reimplemented in Dune::dgf::BoundaryDomBlock.

Referenced by Dune::dgf::BasicBlock::BasicBlock(), Dune::dgf::BasicBlock::findtoken(), Dune::dgf::VertexBlock::get(), Dune::dgf::CubeBlock::get(), Dune::dgf::BasicBlock::gettokenparam(), and Dune::dgf::IntervalBlock::IntervalBlock().

---

Friends And Related Function Documentation

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

---

Member Data Documentation

std::string Dune::dgf::GridParameterBlock::dumpFileName_ [protected]

Referenced by dumpFileName(), and GridParameterBlock().

const Flags Dune::dgf::GridParameterBlock::foundDumpFileName = 1 << 1 [static]

Referenced by dumpFileName(), and GridParameterBlock().

Flags Dune::dgf::GridParameterBlock::foundFlags_ [protected]

Referenced by dumpFileName(), GridParameterBlock(), markLongestEdge(), and name().

const Flags Dune::dgf::GridParameterBlock::foundLongestEdge = 1 << 5 [static]

Referenced by GridParameterBlock(), and markLongestEdge().

const Flags Dune::dgf::GridParameterBlock::foundName = 1 << 0 [static]

Referenced by GridParameterBlock(), and name().

std::stringstream Dune::dgf::BasicBlock::line [protected, inherited]

Referenced by Dune::dgf::BoundaryDomBlock::BoundaryDomBlock(), Dune::dgf::DimBlock::DimBlock(), and Dune::dgf::BasicBlock::getnextentry().

bool Dune::dgf::GridParameterBlock::markLongestEdge_ [protected]

Referenced by GridParameterBlock(), and markLongestEdge().

std::string Dune::dgf::GridParameterBlock::name_ [protected]

Referenced by GridParameterBlock(), and name().

---

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

• gridparameter.hh
• gridparameter.cc