IPF (Input Parameter File) Format

IPF is a data file format to store parameters for a finite element program using OFELI.
The main principle here is that any information in the file is contained in a line and is defined by a keyword following the rules:

• The first line must contain at the first columns the string #PARAM!
• All other lines contain keywords and other parameters separated by any number of spaces following FFI rules. The following lines must contain sequences of one keyword and one (or more) parameter :

Sequence	Information
Proj <project name>	Define a name for a project. A project name is useful to assign default file names for all used files in a code. i.e. all used files will have as default prefix this project name
Verbose <integer>	Define a level for information output. Typically, the integer number must be between 1 and 10. Its default value is 1
Output <integer>	Define a level for solution output. Its default value is 0
Save <integer>	Define a level for solution saving in file. Its default value is 0
Plot <integer>	Define a level for solution saving in plot file. Its default value is 0
BC <integer>	Define a flag level for boundary condition (Dirichlet) handling. 1: Read boundary condition vector in a VDF file (Default value) 2: Read boundary condition vector in a FDF file
BF <integer>	Define a flag level for body force handling. 1: Read body force vector in a VDF file (Default value) 2: Read body force vector in a FDF file
SF <integer>	Define a flag level for surface force (Neumann boundary condition) handling. 1: Read surface force vector in a VDF file (Default value) 2: Read surface force vector in a FDF file
Init <integer>	Define a flag level for initial condition handling. 1: Read initial solution in a VDF file (Default value) 2: Read initial solution in a FDF file
MaxTime <double>	Define maximal time for a time dependent calculation. Its default value is 1.0
TimeStep <double>	Define time step for a time dependent calculation. Its default value is 0.1
NbSteps <integer>	Define number of time steps for a time dependent calculation. Its default value is 10
NbIter <integer>	Define maximum number of iterations for an iterative scheme. Its default value is 100
Tolerance <double>	Define a tolerance for convergence for an iterative scheme. Its default value is 1.e-6
IntPar <int>	Define an integer parameter that can be retrieved by the member function getIntPar(i) where i is the rank of appearance of this keyword. Up to 10 integer parameters can be contained in the file. This maximal number is defined by the constant MAX_NB_PAR in the OFELI constants
DoublePar <double>	Define a double precision parameter that can be retrieved by the member function getDoublePar(i) where i is the rank of appearance of this keyword. Up to 10 double precision parameters can be contained in the file. This maximal number is defined by the constant MAX_NB_PAR in the OFELI constants
ComplexPar <complex>	Define a complex parameter that can be retrieved by the member function getComplexPar(i) where i is the rank of appearance of this keyword. Up to 10 complex parameters can be contained in the file. This maximal number is defined by the constant MAX_NB_PAR in the OFELI constants
MeshFile <file name>	Define the file that contains mesh data. This file must be in MDF format. The default mesh file name has as suffix '.m'
InitFile <file name>	Define the file that contains initial data in FDF format
RestartFile <file name>	Define the file that contains restarting field file in FDF format. This file is useful when an iteration process (or time stepping procedure) is used and the programs stops to restart later
BCFile <file name>	Define the file that contains (Dirichlet) boundary condition data in FDF format
BFFile <file name>	Define the file that contains body force initial data in FDF format
SFFile <file name>	Define the file that contains surface force data in FDF format
SaveFile <file name>	Define the file that fields to save in FDF format
PlotFile <file name>	Define the file that contains fields to plot in FDF format
DataFile <file name>	Define the file that contains various data in FDF format
AuxFile <file name>	Define the file that contains any other data in any format. Any occurrence of this keyword will define a new file name that can be retrieved through the member function getAuxFile(i) where i is the rank of the appearance of this keyword. Up to 10 occurrences can be contained in the file. This maximal number is defined by the constant MAX_NB_PAR in the OFELI constants
EOF	End of File. Anything beyond this keyword will be ignored.