The Fem Eoc Table writer. More...

#include <dune/fem/misc/femeoctable.hh>

Public Member Functions
	FemEocTable ()

	~FemEocTable ()

Static Public Member Functions
static FemEocTable &	instance ()

static int	initialize (const std::string &path, const std::string &name, const std::string &descript)

static int	initialize (const std::string &name, const std::string &descript)

template<class StrVectorType >
static size_t	addEntry (const int tabId, const StrVectorType &descript, size_t size)
	add a vector of new eoc values

template<class StrVectorType >
static size_t	addEntry (const StrVectorType &descript, size_t size)

template<class StrVectorType >
static size_t	addEntry (const int tabId, const StrVectorType &descript)
	add a vector of new eoc values

template<class StrVectorType >
static size_t	addEntry (const StrVectorType &descript)

static size_t	addEntry (const int tabId, const std::string &descript)
	add a single new eoc output

static size_t	addEntry (const std::string &descript)

static size_t	addEntry (const int tabId, const char *descript)
	add a single new eoc output

static size_t	addEntry (const char *descript)

template<class VectorType >
static void	setErrors (const int tabId, size_t id, const VectorType &err, int size)
	add a vector of error values for the given id (returned by addEntry)

template<class VectorType >
static void	setErrors (size_t id, const VectorType &err, int size)

template<class VectorType >
static void	setErrors (const int tabId, size_t id, const VectorType &err)
	add a vector of error values for the given id (returned by addEntry)

template<class VectorType >
static void	setErrors (size_t id, const VectorType &err)

template<int SIZE>
static void	setErrors (const int tabId, size_t id, const FieldVector< double, SIZE > &err)
	add a vector in a FieldVector of error values for the given id (returned by addEntry)

template<int SIZE>
static void	setErrors (size_t id, const FieldVector< double, SIZE > &err)

static void	setErrors (const int tabId, size_t id, const double &err)
	add a single error value for the given id (returned by addEntry)

static void	setErrors (size_t id, const double &err)

static void	write (const int tabId, std::vector< double > &vals, std::vector< std::string > &descriptions, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")
	commit a line to the eoc file

static void	write (std::vector< double > &vals, std::vector< std::string > &descriptions, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")

template<class EocCalculatorType >
static void	write (const int tabId, std::vector< double > &vals, std::vector< std::string > &descriptions, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")
	commit a line to the eoc file, using EocCalculatorType to calculate the eoc.

template<class EocCalculatorType >
static void	write (std::vector< double > &vals, std::vector< std::string > &descriptions, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")

static void	write (const int tabId, std::vector< double > &vals, std::vector< std::string > &descriptions, std::ostream &out, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")
	commit a line to the eoc file

static void	write (std::vector< double > &vals, std::vector< std::string > &descriptions, std::ostream &out, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")

template<class EocCalculatorType >
static void	write (const int tabId, std::vector< double > &vals, std::vector< std::string > &descriptions, std::ostream &out, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")
	commit a line to the eoc file, using EocCalculatorType for non standart Eoc calculations.

template<class EocCalculatorType >
static void	write (std::vector< double > &vals, std::vector< std::string > &descriptions, std::ostream &out, std::string delimiter=" ", std::string terminatingChar="", std::string header="", std::string tableSpacer="", std::string footer="")

Friends
class	Dune::Fem::Singleton< FemEocTable >

Detailed Description

The Fem Eoc Table writer.

Constructor & Destructor Documentation

◆ FemEocTable()

Dune::Fem::FemEocTable::FemEocTable ( )

inline

◆ ~FemEocTable()

Dune::Fem::FemEocTable::~FemEocTable ( )

inline

Member Function Documentation

◆ addEntry() [1/8]

static size_t Dune::Fem::FemEocTable::addEntry ( const char * descript )

inlinestatic

◆ addEntry() [2/8]

static size_t Dune::Fem::FemEocTable::addEntry	(	const int	tabId,
		const char *	descript
	)

inlinestatic

add a single new eoc output

Parameters

tabId	Id of the table we want to add an entry
descript	vector with entry description

Returns: a unique index used to add the error values

◆ addEntry() [3/8]

static size_t Dune::Fem::FemEocTable::addEntry	(	const int	tabId,
		const std::string &	descript
	)

inlinestatic

add a single new eoc output

Parameters

tabId	Id of the table we want to add an entry
descript	vector with entry description

Returns: a unique index used to add the error values

◆ addEntry() [4/8]

template<class StrVectorType >

static size_t Dune::Fem::FemEocTable::addEntry	(	const int	tabId,
		const StrVectorType &	descript
	)

inlinestatic

add a vector of new eoc values

Parameters

tabId Id of the table we inserte a value

Template Parameters

StrVectorType a vector type with size() and operator[] returning a string

Parameters

descript vector with entry description

Returns: a unique index used to add the error values

◆ addEntry() [5/8]

template<class StrVectorType >

static size_t Dune::Fem::FemEocTable::addEntry	(	const int	tabId,
		const StrVectorType &	descript,
		size_t	size
	)

inlinestatic

add a vector of new eoc values

Parameters

tabId Id of the table we inserte a value

Template Parameters

StrVectorType a vector type with operator[] returning a string (a C style array can be used) the size of the vector is given as parameter

Parameters

descript	vector with entry description
size	length of description

Returns: a unique index used to add the error values

◆ addEntry() [6/8]

static size_t Dune::Fem::FemEocTable::addEntry ( const std::string & descript )

inlinestatic

◆ addEntry() [7/8]

template<class StrVectorType >

static size_t Dune::Fem::FemEocTable::addEntry ( const StrVectorType & descript )

inlinestatic

◆ addEntry() [8/8]

template<class StrVectorType >

static size_t Dune::Fem::FemEocTable::addEntry	(	const StrVectorType &	descript,
		size_t	size
	)

inlinestatic

◆ initialize() [1/2]

static int Dune::Fem::FemEocTable::initialize	(	const std::string &	name,
		const std::string &	descript
	)

inlinestatic

creates a new table and opens file name as above returns the Id of the table opened.

◆ initialize() [2/2]

static int Dune::Fem::FemEocTable::initialize	(	const std::string &	path,
		const std::string &	name,
		const std::string &	descript
	)

inlinestatic

creates a new table and opens the corresponding file path/name returns the Id of the created table.

◆ instance()

static FemEocTable & Dune::Fem::FemEocTable::instance ( )

inlinestatic

◆ setErrors() [1/8]

static void Dune::Fem::FemEocTable::setErrors	(	const int	tabId,
		size_t	id,
		const double &	err
	)

inlinestatic

add a single error value for the given id (returned by addEntry)

Parameters

tabId	Id of the table we want to set errors
id	Id of the error
err	Vector containing the error

◆ setErrors() [2/8]

template<int SIZE>

static void Dune::Fem::FemEocTable::setErrors	(	const int	tabId,
		size_t	id,
		const FieldVector< double, SIZE > &	err
	)

inlinestatic

add a vector in a FieldVector of error values for the given id (returned by addEntry)

Parameters

tabId	Id of the table we want to set errors
id	Id of the error
err	Vector containing the error

◆ setErrors() [3/8]

template<class VectorType >

static void Dune::Fem::FemEocTable::setErrors	(	const int	tabId,
		size_t	id,
		const VectorType &	err
	)

inlinestatic

add a vector of error values for the given id (returned by addEntry)

Parameters

tabId	Id of the table we want to set errors
id	Id of the error
err	Vector containing the error

Template Parameters

VectorType a vector type with a size() and an operator[] returning a double

◆ setErrors() [4/8]

template<class VectorType >

static void Dune::Fem::FemEocTable::setErrors	(	const int	tabId,
		size_t	id,
		const VectorType &	err,
		int	size
	)

inlinestatic

add a vector of error values for the given id (returned by addEntry)

Parameters

tabId	Id of the table we want to set errors
id	Id of the error
err	Vector containing the error
size	Size of error Vector

Template Parameters

VectorType a vector type with an operator[] returning a double (C style array can be used)

◆ setErrors() [5/8]

static void Dune::Fem::FemEocTable::setErrors	(	size_t	id,
		const double &	err
	)

inlinestatic

◆ setErrors() [6/8]

template<int SIZE>

static void Dune::Fem::FemEocTable::setErrors	(	size_t	id,
		const FieldVector< double, SIZE > &	err
	)

inlinestatic

◆ setErrors() [7/8]

template<class VectorType >

static void Dune::Fem::FemEocTable::setErrors	(	size_t	id,
		const VectorType &	err
	)

inlinestatic

◆ setErrors() [8/8]

template<class VectorType >

static void Dune::Fem::FemEocTable::setErrors	(	size_t	id,
		const VectorType &	err,
		int	size
	)

inlinestatic

◆ write() [1/8]

static void Dune::Fem::FemEocTable::write	(	const int	tabId,
		std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::ostream &	out,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

commit a line to the eoc file

Parameters

tabId	table Id returned by the initial function
vals	std::vector of vals that should appear in the EOC table
descriptions	std::vector with descriptions of the values that should appear
terminatingChar	char which ends an entry, default = " "
out	std::ostream to print data to (e.g. std::cout)
header	header string for Latex output, default = " "
tableSpacer	spacer for empty columns in the table, default = " "
footer	footer string for Latex output, default = " "
delimiter	spacer between the entries, default " "

◆ write() [2/8]

template<class EocCalculatorType >

static void Dune::Fem::FemEocTable::write	(	const int	tabId,
		std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::ostream &	out,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

commit a line to the eoc file, using EocCalculatorType for non standart Eoc calculations.

Parameters

tabId	table Id returned by the initial function
vals	std::vector of vals that should appear in the EOC table
descriptions	std::vector with descriptions of the values that should appear
terminatingChar	char which ends an entry, default = " "
out	std::ostream to print data to (e.g. std::cout)
header	header string for Latex output, default = " "
tableSpacer	spacer for empty columns in the table, default = " "
footer	footer string for Latex output, default = " "
delimiter	spacer between the entries, default " "

◆ write() [3/8]

static void Dune::Fem::FemEocTable::write	(	const int	tabId,
		std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

commit a line to the eoc file

Parameters

tabId	table Id returned by the initial function
vals	std::vector of vals that should appear in the EOC table, vals[0] is expected to be a charateristical value.
descriptions	std::vector with descriptions of the values that should appear
terminatingChar	char which ends an entry, default = " "
header	header string for Latex output, default = ""
tableSpacer	spacer for empty columns in the table, default = ""
footer	footer string for Latex output, default = ""
delimiter	spacer between the entries, default =" "

◆ write() [4/8]

template<class EocCalculatorType >

static void Dune::Fem::FemEocTable::write	(	const int	tabId,
		std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

commit a line to the eoc file, using EocCalculatorType to calculate the eoc.

Parameters

tabId	table Id returned by the initial function
vals	std::vector of vals that should appear in the EOC table, vals[0] is expected to be a charateristical value.
descriptions	std::vector with descriptions of the values that should appear
terminatingChar	char which ends an entry, default = " "
header	header string for Latex output, default = ""
tableSpacer	spacer for empty columns in the table, default = ""
footer	footer string for Latex output, default = ""
delimiter	spacer between the entries, default =" "

◆ write() [5/8]

static void Dune::Fem::FemEocTable::write	(	std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::ostream &	out,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

◆ write() [6/8]

template<class EocCalculatorType >

static void Dune::Fem::FemEocTable::write	(	std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::ostream &	out,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

◆ write() [7/8]

static void Dune::Fem::FemEocTable::write	(	std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

◆ write() [8/8]

template<class EocCalculatorType >

static void Dune::Fem::FemEocTable::write	(	std::vector< double > &	vals,
		std::vector< std::string > &	descriptions,
		std::string	delimiter = `" "`,
		std::string	terminatingChar = `""`,
		std::string	header = `""`,
		std::string	tableSpacer = `""`,
		std::string	footer = `""`
	)

inlinestatic

Friends And Related Symbol Documentation

◆ Dune::Fem::Singleton< FemEocTable >

friend class Dune::Fem::Singleton< FemEocTable >

friend

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

femeoctable.hh

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FemEocTable()

◆ ~FemEocTable()

Member Function Documentation

◆ addEntry() [1/8]

◆ addEntry() [2/8]

◆ addEntry() [3/8]

◆ addEntry() [4/8]

◆ addEntry() [5/8]

◆ addEntry() [6/8]

◆ addEntry() [7/8]

◆ addEntry() [8/8]

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ instance()

◆ setErrors() [1/8]

◆ setErrors() [2/8]

◆ setErrors() [3/8]

◆ setErrors() [4/8]

◆ setErrors() [5/8]

◆ setErrors() [6/8]

◆ setErrors() [7/8]

◆ setErrors() [8/8]

◆ write() [1/8]

◆ write() [2/8]

◆ write() [3/8]

◆ write() [4/8]

◆ write() [5/8]

◆ write() [6/8]

◆ write() [7/8]

◆ write() [8/8]

Friends And Related Symbol Documentation

◆ Dune::Fem::Singleton< FemEocTable >