concepts::ModelControlBase< F > Class Template Reference

Base class for controlling a model. More...

#include <models.hh>

Inheritance diagram for concepts::ModelControlBase< F >:

Collaboration diagram for concepts::ModelControlBase< F >:

List of all members.

Public Member Functions
void	basisFunctions (const std::string path="")
	Writes matlab graphics files for each basis function of the space of the model.
virtual void	dataOut (concepts::InOutParameters &parameters, const bool store=false, const std::string path="")
	Append the parameters of the calculation to parameters and writes it in matlab format if path is given.
void	loadSolution (const std::string vectorFile)
	Loads solution vector from vectorFile.
virtual F &	model ()
	Returns the model.
virtual const F &	model () const
	ModelControlBase (F &model)
	Constructor.
const concepts::InOutParameters &	parameters () const
	Return parameters of the calculation.
void	writeSolution (const std::string vectorFile, bool verbose=true)
	Writes solution vector to vectorFile.
virtual	~ModelControlBase ()
Protected Member Functions
virtual std::string	filename_ (const std::string varname, const std::string path, const bool flag=false)
	Gives a file name for different outputs.
template<class G >
void	formulaOut_ (const concepts::PiecewiseFormulaBase< G > &frm, const std::string frmstr, const std::string name)
	graphical output of formulas
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
void	newfile_ (std::string &name, const std::string varname, const std::string ending)
	Tries, if given file can be opened for writing or if its a path.
Protected Attributes
F &	model_
	The model.
concepts::InOutParameters	parameters_
	Parameters of the calculation.

---

Detailed Description

template<class F>
class concepts::ModelControlBase< F >

Base class for controlling a model.

Implemenent a model with an appropiate space and solver. Use ModelControl and derived classes to enclose methods, which are called when using a model.

Definition at line 93 of file models.hh.

---

Constructor & Destructor Documentation

template<class F>

concepts::ModelControlBase< F >::ModelControlBase

(

F &

model

)

[inline]

Constructor.

Definition at line 96 of file models.hh.

template<class F>

virtual concepts::ModelControlBase< F >::~ModelControlBase

(

)

[inline, virtual]

Definition at line 99 of file models.hh.

---

Member Function Documentation

template<class F>

void concepts::ModelControlBase< F >::basisFunctions

(

const std::string

path = ""

)

Writes matlab graphics files for each basis function of the space of the model.

template<class F>

virtual void concepts::ModelControlBase< F >::dataOut	(	concepts::InOutParameters &	parameters,
		const bool	store = false,
		const std::string	path = ""
	)		[virtual]

Append the parameters of the calculation to parameters and writes it in matlab format if path is given.

template<class F>

virtual std::string concepts::ModelControlBase< F >::filename_	(	const std::string	varname,
		const std::string	path,
		const bool	flag = false
	)		[protected, virtual]

Gives a file name for different outputs.

Due to derivation the name can be adopted. At the moment its like "path/varname_mshAbbr".

Parameters:

varname	name of an variable
path	path
p	some flag

template<class F >

template<class G >

void concepts::ModelControlBase< F >::formulaOut_	(	const concepts::PiecewiseFormulaBase< G > &	frm,
		const std::string	frmstr,
		const std::string	name
	)		[protected]

graphical output of formulas

Definition at line 160 of file models.hh.

template<class F>

virtual std::ostream& concepts::ModelControlBase< F >::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in concepts::ModelControl< hp2D::Eddy2D_E >, concepts::ModelControl< hp2D::Maxwell2D_E >, concepts::ModelControl< hp2D::Maxwell2D_H_Base >, concepts::ModelControl< hp2D::Maxwell2D_H >, and concepts::ModelControl< hp2D::Maxwell2D_H_DD >.

template<class F>

void concepts::ModelControlBase< F >::loadSolution

(

const std::string

vectorFile

)

Loads solution vector from vectorFile.

template<class F>

virtual F& concepts::ModelControlBase< F >::model

(

)

[inline, virtual]

Returns the model.

Reimplemented in concepts::ModelControl< hp2D::Eddy2D_E >, concepts::ModelControl< hp2D::Maxwell2D_E >, concepts::ModelControl< hp2D::Maxwell2D_H_Base >, concepts::ModelControl< hp2D::Maxwell2D_H >, and concepts::ModelControl< hp2D::Maxwell2D_H_DD >.

Definition at line 101 of file models.hh.

template<class F>

virtual const F& concepts::ModelControlBase< F >::model

(

)

const [inline, virtual]

Reimplemented in concepts::ModelControl< hp2D::Eddy2D_E >, concepts::ModelControl< hp2D::Maxwell2D_E >, concepts::ModelControl< hp2D::Maxwell2D_H_Base >, concepts::ModelControl< hp2D::Maxwell2D_H >, and concepts::ModelControl< hp2D::Maxwell2D_H_DD >.

Definition at line 102 of file models.hh.

template<class F>

void concepts::ModelControlBase< F >::newfile_	(	std::string &	name,
		const std::string	varname,
		const std::string	ending
	)		[protected]

Tries, if given file can be opened for writing or if its a path.

In latter case opens gives back a standard filename with ending and use of varname.

If the given string is neither possible to open or a path a empty string is given to name.

template<class F>

const concepts::InOutParameters& concepts::ModelControlBase< F >::parameters

(

)

const [inline]

Return parameters of the calculation.

Definition at line 120 of file models.hh.

template<class F>

void concepts::ModelControlBase< F >::writeSolution	(	const std::string	vectorFile,
		bool	verbose = true
	)

Writes solution vector to vectorFile.

Writes a message to cout, if not verbose.

---

Member Data Documentation

template<class F>

F& concepts::ModelControlBase< F >::model_ [protected]

The model.

Definition at line 126 of file models.hh.

template<class F>

concepts::InOutParameters concepts::ModelControlBase< F >::parameters_ [protected]

Parameters of the calculation.

Definition at line 128 of file models.hh.

---

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

• models/models.hh