From 749591f8143503418eee1f9e29da84ef10c779aa Mon Sep 17 00:00:00 2001 From: bangerth Date: Thu, 8 Feb 2007 20:44:52 +0000 Subject: [PATCH] Add a warning that intermediate format is volatile. git-svn-id: https://svn.dealii.org/trunk@14425 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/data_out_base.h | 26 ++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index 71ae664f0b..b8cc312142 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -2033,6 +2033,12 @@ class DataOutBase * is then converted in the present class to the final graphics * format. * + * Note that the intermediate format is what its name suggests: a + * direct representation of internal data. It isn't standardized and + * will change whenever we change our internal representation. You can + * only expect to process files written in this format using the same + * version of deal.II that was used for writing. + * * The reason why we offer to write out this intermediate format is * that it can be read back into a deal.II program using the * DataOutReader class, which is helpful in at least two contexts: @@ -2526,6 +2532,19 @@ class DataOutInterface : private DataOutBase * in deal.II intermediate * format. See * DataOut::write_deal_II_intermediate. + * + * Note that the intermediate + * format is what its name + * suggests: a direct + * representation of internal + * data. It isn't standardized + * and will change whenever we + * change our internal + * representation. You can only + * expect to process files + * written in this format using + * the same version of deal.II + * that was used for writing. */ void write_deal_II_intermediate (std::ostream &out) const; @@ -2846,7 +2865,12 @@ class DataOutInterface : private DataOutBase * run time, even though the compiler already needs it at compile time. A way * around using the DataOutBase::determine_intermediate_format_dimensions() * function is explained in @ref step_19 "step-19". - * + * + * Note that the intermediate format is what its name suggests: a + * direct representation of internal data. It isn't standardized and + * will change whenever we change our internal representation. You can + * only expect to process files written in this format using the same + * version of deal.II that was used for writing. * * @ingroup input output * @author Wolfgang Bangerth, 2005 -- 2.39.5