Dune::dgf::YaspGridParameterBlock Class Reference

Grid parameters for YaspGridThe 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. 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

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

inherited

Constructor & Destructor Documentation

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

inline

constructor taking istream

References _overlap, Dune::dgf::BasicBlock::findtoken(), and Dune::dgf::BasicBlock::getnextentry().

Member Function Documentation

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

inlineinherited

References Dune::dgf::GridParameterBlock::dumpFileName_, Dune::dgf::GridParameterBlock::foundDumpFileName, and Dune::dgf::GridParameterBlock::foundFlags_.

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

protectedinherited

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

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

template<class ENTRY >

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

inlineprotectedinherited

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

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

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

protectedinherited

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

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

protectedinherited

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

inlineinherited

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

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

inlineinherited

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

inlineinherited

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

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

inlineinherited

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

inlineinherited

returns true if longest edge should be marked for AlbertaGrid

References Dune::dgf::GridParameterBlock::foundFlags_, Dune::dgf::GridParameterBlock::foundLongestEdge, and Dune::dgf::GridParameterBlock::markLongestEdge_.

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

inlineinherited

return the name of the grid

References Dune::dgf::GridParameterBlock::foundFlags_, Dune::dgf::GridParameterBlock::foundName, and Dune::dgf::GridParameterBlock::name_.

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

inlineinherited

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

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

inlineinherited

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

inline

get dimension of world found in block

References _overlap.

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

inlineprotectedinherited

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

Member Data Documentation

int Dune::dgf::YaspGridParameterBlock::_overlap

protected

Referenced by overlap(), and YaspGridParameterBlock().

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

protectedinherited

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

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

staticinherited

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

Flags Dune::dgf::GridParameterBlock::foundFlags_

protectedinherited

Referenced by Dune::dgf::GridParameterBlock::dumpFileName(), Dune::dgf::GridParameterBlock::GridParameterBlock(), Dune::dgf::GridParameterBlock::markLongestEdge(), and Dune::dgf::GridParameterBlock::name().

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

staticinherited

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

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

staticinherited

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

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

protectedinherited

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

bool Dune::dgf::GridParameterBlock::markLongestEdge_

protectedinherited

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

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

protectedinherited

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

---

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

• dgfyasp.hh