IPF Class Reference
[Input/Output]

#include <IPF.h>

List of all members.

---

Detailed Description

To read parameters from a file in IPF format.

This class can be used to acquire various parameters from a parameter file of IPF (Input Parameter Format). The declaration of an instance of this class avoids reading data in your main program. The acquired parameters are retrieved through information members of the class. Note that all the parameters have default values

Public Member Functions
string	getAuxFile (size_t i=1) const
	Return i-th parameter read using keyword Auxfile.
int	getBC () const
	Return parameter read using keyword BC.
string	getBCFile () const
	Return parameter read using keyword BCFile.
int	getBF () const
	Return parameter read using keyword BF.
string	getBFFile () const
	Return parameter read using keyword BFFile.
complex_t	getComplexPar (size_t n=1) const
	Return n-th parameter read using keyword StringPar.
int	getData () const
	Return parameter read using keyword Data.
string	getDataFile () const
	Return parameter read using keyword DataFile.
string	getDensity () const
	Return expression (to be parsed, function of x, y, z, t) for density function.
double	getDisplay ()
	Display acquired parameters.
double	getDoublePar (size_t n=1) const
	Return n-th parameter read using keyword DoublePar.
string	getElectricConductivity () const
	Return expression (to be parsed, function of x, y, z, t) for electric conductivity.
string	getElectricPermittivity () const
	Return expression (to be parsed, function of x, y, z, t) for electric permittivity.
int	getInit () const
	Return parameter read using keyword Init.
string	getInitFile () const
	Return parameter read using keyword InitFile.
int	getIntPar (size_t n=1) const
	Return n-th parameter read using keyword IntPar.
string	getMagneticPermeability () const
	Return expression (to be parsed, function of x, y, z, t) for magnetic permeability.
double	getMaxTime () const
	Return parameter read using keyword MaxTime.
string	getMeshFile (size_t i=1) const
	Return i-th parameter read using keyword Mesh.
size_t	getNbIter () const
	Return parameter read using keyword NbIter.
size_t	getNbSteps () const
	Return parameter read using keyword NbSteps.
int	getOutput () const
	Return parameter read using keyword Output.
int	getPlot () const
	Return parameter read using keyword Plot.
string	getPlotFile (int i=1) const
	Return i-th parameter read using keyword PlotFile.
Point< double >	getPointDoublePar (size_t n=1) const
	Return n-th parameter read using keyword PointDoublePar.
string	getPoissonRatio () const
	Return expression (to be parsed, function of x, y, z, t) for Poisson ratio.
string	getPrescriptionFile () const
	Return parameter read using keyword DataFile.
string	getProject () const
	Return parameter read using keyword Project.
string	getRestartFile () const
	Return parameter read using keyword RestartFile.
string	getRhoCp () const
	Return expression (to be parsed, function of x, y, z, t) for density * specific heat.
int	getSave () const
	Return parameter read using keyword Save.
string	getSaveFile () const
	Return parameter read using keyword SaveFile.
int	getSF () const
	Return parameter read using keyword SF.
string	getSFFile () const
	Return parameter read using keyword SFFile.
string	getStringPar (size_t n=1) const
	Return n-th parameter read using keyword StringPar.
string	getThermalConductivity () const
	Return expression (to be parsed, function of x, y, z, t) for thermal conductivity.
double	getTimeStep () const
	Return parameter read using keyword TimeStep.
double	getTolerance () const
	Return parameter read using keyword Tolerance.
int	getVerbose () const
	Return parameter read using keyword Verbose.
string	getViscosity () const
	Return expression (to be parsed, function of x, y, z, t) for viscosity.
string	getYoungModulus () const
	Return expression (to be parsed, function of x, y, z, t) for Young's modulus.
	IPF (const string &prog, const string &file)
	Constructor that reads parameters in file file and prints header information for the calling program prog.
	IPF (const string &file)
	Constructor that gives the data file name.
	~IPF ()
	Destructor.

---

Constructor & Destructor Documentation

IPF

(

const string &

file

)

Constructor that gives the data file name.

It reads parameters in IPF Format from this file.

IPF	(	const string &	prog,
		const string &	file
	)

Constructor that reads parameters in file file and prints header information for the calling program prog.

It reads parameters in IPF Format from this file.

---

Member Function Documentation

string getAuxFile

(

size_t

i = 1

)

const

Return i-th parameter read using keyword Auxfile.

Here we have at most 10 integer extra parameters that can be used for any auxiliary file names. Default value for i is 1.

int getBC

(

)

const

Return parameter read using keyword BC.

This parameter can be used to set a boundary condition flag.

string getBCFile

(

)

const

Return parameter read using keyword BCFile.

This parameter can be used to read a boundary condition file name.

int getBF

(

)

const

Return parameter read using keyword BF.

This parameter can be used to set a body force flag.

string getBFFile

(

)

const

Return parameter read using keyword BFFile.

This parameter can be used to read a body force file name.

complex_t getComplexPar

(

size_t

n = 1

)

const

Return n-th parameter read using keyword StringPar.

Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1. Return n-th parameter read using keyword StringPar. Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1.

int getData

(

)

const

Return parameter read using keyword Data.

This parameter can be used to set a various data flag.

string getDataFile

(

)

const

Return parameter read using keyword DataFile.

This parameter can be used to read a VDF data file.

double getDoublePar

(

size_t

n = 1

)

const

Return n-th parameter read using keyword DoublePar.

Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1.

int getInit

(

)

const

Return parameter read using keyword Init.

This parameter can be used to set an initial data flag.

string getInitFile

(

)

const

Return parameter read using keyword InitFile.

This parameter can be used to read an initial data file name.

int getIntPar

(

size_t

n = 1

)

const

Return n-th parameter read using keyword IntPar.

Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1.

double getMaxTime

(

)

const

Return parameter read using keyword MaxTime.

This parameter can be used to read a maximum time value.

string getMeshFile

(

size_t

i = 1

)

const

Return i-th parameter read using keyword Mesh.

Here we have at most 10 integer extra parameters that can be used for any purpose. Default value for i is 1.

size_t getNbIter

(

)

const

Return parameter read using keyword NbIter.

This parameter can be used to read a number of iterations.

size_t getNbSteps

(

)

const

Return parameter read using keyword NbSteps.

This parameter can be used to read a number of time steps.

int getOutput

(

)

const

Return parameter read using keyword Output.

This parameter can be used to control output behavior in a program.

int getPlot

(

)

const

Return parameter read using keyword Plot.

This parameter can be used to control result saving for plotting in a program.

string getPlotFile

(

int

i = 1

)

const

Return i-th parameter read using keyword PlotFile.

Here we have at most 10 integer extra parameters that can be used for plot file names. Default value for i is 1.

Point<double> getPointDoublePar

(

size_t

n = 1

)

const

Return n-th parameter read using keyword PointDoublePar.

Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1.

string getPrescriptionFile

(

)

const

Return parameter read using keyword DataFile.

This parameter can be used to read a VDF data file.

string getProject

(

)

const

Return parameter read using keyword Project.

This parameter can be used to read a project's name.

string getRestartFile

(

)

const

Return parameter read using keyword RestartFile.

This parameter can be used to read a restart file name.

int getSave

(

)

const

Return parameter read using keyword Save.

This parameter can be used to control result saving in a program (e.g. for a restarting purpose).

string getSaveFile

(

)

const

Return parameter read using keyword SaveFile.

This parameter can be used to read a save file name.

int getSF

(

)

const

Return parameter read using keyword SF.

This parameter can be used to set a surface force flag.

string getSFFile

(

)

const

Return parameter read using keyword SFFile.

This parameter can be used to read a source force file name.

string getStringPar

(

size_t

n = 1

)

const

Return n-th parameter read using keyword StringPar.

Here we have at most 20 integer extra parameters that can be used for any purpose. Default value for n is 1.

double getTimeStep

(

)

const

Return parameter read using keyword TimeStep.

This parameter can be used to read a time step value.

double getTolerance

(

)

const

Return parameter read using keyword Tolerance.

This parameter can be used to read a tolerance value to control convergence.