*
* Listing of Parameters
* ---------------------
- * Equation 1 = Poisson <Laplace>
- * Equation 2 = Navier-Stokes <Elasticity>
- * Output file= out
+ * set Equation 1 = Poisson # Laplace
+ * set Equation 2 = Navier-Stokes # Elasticity
+ * set Output file = out
* subsection Equation 1
- * Matrix type = Sparse <Sparse>
+ * set Matrix type = Sparse # Sparse
* subsection Linear solver
- * Maximum number of iterations = 40 <20>
- * Solver = CG
+ * set Maximum number of iterations = 40 # 20
+ * set Solver = CG
+ * end
+ * end
* subsection Equation 2
- * Matrix type = Full <Sparse>
+ * set Matrix type = Full # Sparse
* subsection Linear solver
- * Maximum number of iterations = 100 <20>
- * Solver = CG <CG>
+ * set Maximum number of iterations = 100 # 20
+ * set Solver = CG # CG
+ * end
+ * end
*
*
* Getting parameters:
* #bool#.
*/
bool get_bool (const string &entry_string) const;
+
/**
* Print all parameters with the given style
- * to #out#. Presently only Text and LaTeX
+ * to #out#. Presently only #Text# and #LaTeX#
* are implemented.
+ *
+ * In #Text# format, the output is formatted
+ * in such a way that it is possible to
+ * use it for later input again. This is most
+ * useful to record the parameters set for
+ * a specific run, since if you output the
+ * parameters using this function into a log
+ * file, you can always recover the results
+ * by simply copying the output to your
+ * input file.
*/
ostream & print_parameters (ostream &out, const OutputStyle style);
-void ParameterHandler::print_parameters_section (ostream &out,
- const OutputStyle style,
+void ParameterHandler::print_parameters_section (ostream &out,
+ const OutputStyle style,
const unsigned int indent_level) {
// assert that only known formats are
// given as "style"
{
case Text:
out << setw(indent_level*2) << ""
+ << "set "
<< ptr->first
<< setw(longest_entry-ptr->first.length()+3) << " = "
<< pc->entries[ptr->first].first
- << " <"
+ << " #"
<< pd->entries[ptr->first].first
- << ">"
<< endl;
break;
case LaTeX:
{
case Text:
out << setw(indent_level*2) << ""
+ << "set "
<< ptr->first
<< setw(longest_entry-ptr->first.length()+2) << "= "
<< ptr->second.first << endl;
switch (style)
{
case Text:
+ out << setw(indent_level*2) << ""
+ << "end" << endl;
break;
case LaTeX:
out << "\\end{itemize}"