* course at the expense of getting only an approximate result.)
* </ol>
*
- * When recording a new mnemonic name, the user must supply a std::vector<bool>
- * component_mask to indicate the @ref GlossComponent "(vector) components" to be
- * extracted from the given input. If the user simply wants to extract all the components,
- * then default parameters
- * the mask need not be explicitly supplied to the @p add_field_name method.
- * If the @p evaluate_field with a @p DataPostprocessor object is used, the component_mask
- * interpreted as the mask of the @p DataPostprocessor return vector. The size of this
- * mask can be different to that of the FE space, but must be provided when the
- * @p add_field_name method is called. One variant of the @p add_field_name method allows
- * provides an unsigned int input to construct a suitable mask, if all values from the
- * @p DataPostprocessor are desired.
+ * When recording a new mnemonic name, the user must supply a
+ * std::vector@<bool@> component_mask (see @ref GlossComponentMask "this glossary entry")
+ * to indicate the @ref GlossComponent "(vector) components"
+ * to be extracted from the given input. If the user simply wants to extract
+ * all the components, the mask need not be explicitly supplied to the @p
+ * add_field_name method and the default value of the parameter is sufficient.
+ * If the @p evaluate_field with a @p DataPostprocessor object is used, the
+ * component_mask is interpreted as the mask of the @p DataPostprocessor
+ * return vector. The size of this mask can be different to that of the FE
+ * space, but must be provided when the @p add_field_name method is
+ * called. One variant of the @p add_field_name method allows an unsigned int
+ * input to construct a suitable mask, if all values from the @p
+ * DataPostprocessor are desired.
*
* The class automatically generates names for the data stored based on the mnemonics
* supplied. The methods @p add_component_names and @p add_independent_names allow
* Put another mnemonic string (and hence
* @p VECTOR) into the class. This method
* adds storage space for variables equal
- * to the number of true values in
+ * to the number of true values in
* component_mask.
* This also adds extra entries for points
* that are already in the class, so
void add_field_name(const std::string &vector_name,
const unsigned int n_components);
- /**
- * Provide optional names for each component
- * of a field. These names will be used
- * instead of names generated from the
- * field name, if supplied.
- */
+ /**
+ * Provide optional names for each component
+ * of a field. These names will be used
+ * instead of names generated from the
+ * field name, if supplied.
+ */
void add_component_names(const std::string &vector_name,
- const std::vector <std::string> &component_names);
-
- /**
- * Provide optional names for the
- * independent values. These names will
- * be used instead of "Indep_...", if
- * supplied.
- */
+ const std::vector <std::string> &component_names);
+
+ /**
+ * Provide optional names for the
+ * independent values. These names will
+ * be used instead of "Indep_...", if
+ * supplied.
+ */
void add_independent_names(const std::vector <std::string> &independent_names);
*/
template <class VECTOR>
void evaluate_field(const std::string &name,
- const VECTOR & solution);
+ const VECTOR & solution);
/**
*/
template <class VECTOR>
void evaluate_field(const std::vector <std::string> &names,
- const VECTOR & solution,
- const DataPostprocessor<dim> & data_postprocessor,
- const Quadrature<dim> & quadrature);
+ const VECTOR & solution,
+ const DataPostprocessor<dim> & data_postprocessor,
+ const Quadrature<dim> & quadrature);
/**
* Construct a std::vector <std::string>
*/
template <class VECTOR>
void evaluate_field(const std::string &name,
- const VECTOR & solution,
- const DataPostprocessor<dim> & data_postprocessor,
- const Quadrature<dim> & quadrature);
+ const VECTOR & solution,
+ const DataPostprocessor<dim> & data_postprocessor,
+ const Quadrature<dim> & quadrature);
/**
*/
template <class VECTOR>
void evaluate_field_at_requested_location(const std::string &name,
- const VECTOR & solution);
+ const VECTOR & solution);
/**
* locations output.
*/
void write_gnuplot (const std::string &base_name,
- const std::vector <Point <dim> > postprocessor_locations = std::vector <Point <dim> > ());
+
const std::vector <Point <dim> > postprocessor_locations = std::vector <Point <dim> > ());
/**
* The function mark_support_locations replaces
* it and reflects the fact that the locations
* marked are actually the support points.
- *
- * @deprecated
+ *
+ * @deprecated
*/
Vector<double> mark_locations();
* method.
*/
void get_postprocessor_locations (const Quadrature<dim> & quadrature,
- std::vector<Point <dim> > & locations);
+
std::vector<Point <dim> > & locations);
/**
* Once datasets have been added to the
*/
std::map <std::string, std::vector <std::vector <double> > > data_store;
- /**
- * Saves a component mask
- * for each mnemonic.
- */
- std::map <std::string, std::vector<bool> > component_mask;
+ /**
+ * Saves a component mask
+ * for each mnemonic.
+ */
+ std::map <std::string, std::vector<bool> > component_mask;
/**
unsigned int n_indep;
- /**
- * A function that will be triggered
- * through signals whenever the
- * triangulation is modified.
- *
- * It is currently used to check
- * if the triangulation has changed,
- * invalidating precomputed values.
- */
+ /**
+ * A function that will be triggered
+ * through signals whenever the
+ * triangulation is modified.
+ *
+ * It is currently used to check
+ * if the triangulation has changed,
+ * invalidating precomputed values.
+ */
void tria_change_listener ();
};
projects / dealii-svn.git / commitdiff