/usr/include/deal.II/numerics/data_out_stack.h is in libdeal.ii-dev 8.1.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | // ---------------------------------------------------------------------
// $Id: data_out_stack.h 30036 2013-07-18 16:55:32Z maier $
//
// Copyright (C) 1999 - 2013 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef __deal2__data_out_stack_h
#define __deal2__data_out_stack_h
#include <deal.II/base/config.h>
#include <deal.II/base/data_out_base.h>
#include <deal.II/base/smartpointer.h>
#include <deal.II/lac/vector.h>
#include <string>
#include <vector>
DEAL_II_NAMESPACE_OPEN
template <int dim, int spacedim> class DoFHandler;
/**
* This class is used to stack the output from several computations
* into one output file by stacking the data sets in another
* co-ordinate direction orthogonal to the space directions. The most
* common use is to stack the results of several time steps into one
* space-time output file, or for example to connect the results of
* solutions of a parameter dependent equation for several parameter
* value together into one. The interface is mostly modelled after the
* DataOut class, see there for some more documentation.
*
* We will explain the concept for a time dependent problem, but
* instead of the time any parameter can be substituted. In our
* example, a solution of an equation is computed for each discrete
* time level. This is then added to an object of the present class
* and after all time levels are added, a space-time plot will be
* written in any of the output formats supported by the base
* class. Upon output, the (spatial) solution on each time level is
* extended into the time direction by writing it twice, once for the
* time level itself and once for a time equal to the time level minus
* a given time step. These two copies are connected, to form a
* space-time slab, with constant values in time.
*
* Due to the piecewise constant output in time, the written solution
* will in general be discontinuous at discrete time levels, but the
* output is still sufficient in most cases. More sophisticated
* interpolations in time may be added in the future.
*
*
* <h3>Example of Use</h3>
*
* The following little example shall illustrate the different steps
* of use of this class. It is assumed that the finite element used is
* composed of two components, @p u and @p v, that the solution vector
* is named @p solution and that a vector @p error is computed which
* contains an error indicator for each spatial cell.
*
* Note that unlike for the DataOut class it is necessary to first
* declare data vectors and the names of the components before first
* use. This is because on all time levels the same data should be
* present to produce reasonable time-space output. The output is
* generated with two subdivisions in each space and time direction,
* which is suitable for quadratic finite elements in space, for
* example.
*
* @code
* DataOutStack<dim> data_out_stack;
*
* // first declare the vectors
* // to be used later
* vector<string> solution_names;
* solution_names.push_back ("u");
* solution_names.push_back ("v");
* data_out_stack.declare_data_vector (solution_names,
* DataOutStack<dim>::dof_vector);
* data_out_stack.declare_data_vector ("error",
* DataOutStack<dim>::cell_vector);
*
* // now do computations
* for (double parameter=0; ...)
* {
* DoFHandler<dim,spacedim> dof_handler;
* ... // compute something
*
* // now for output
* data_out_stack.new_parameter_value (parameter,
* delta_parameter);
* data_out_stack.attach_dof_handler (dof_handler);
* data_out_stack.add_data_vector (solution, solution_names);
* data_out_stack.add_data_vector (error, "error");
* data_out_stack.build_patches (2);
* data_out_stack.finish_parameter_value ();
* };
* @endcode
*
* @ingroup output
* @author Wolfgang Bangerth, 1999
*/
template <int dim, int spacedim=dim, class DH = DoFHandler<dim,spacedim> >
class DataOutStack : public DataOutInterface<dim+1>
{
public:
/**
* Data type declaring the two types
* of vectors which are used in this
* class.
*/
enum VectorType { cell_vector, dof_vector };
/**
* Destructor. Only declared to make
* it @p virtual.
*/
virtual ~DataOutStack ();
/**
* Start the next set of data for a
* specific parameter value. The argument
* @p parameter_step denotes the interval
* (in backward direction, counted from
* @p parameter_value) with which the
* output will be extended in parameter
* direction, i.e. orthogonal to the
* space directions.
*/
void new_parameter_value (const double parameter_value,
const double parameter_step);
/**
* Attach the DoF handler for the
* grid and data associated with the
* parameter previously set by
* @p new_parameter_value.
*
* This has to happen before adding
* data vectors for the present
* parameter value.
*/
void attach_dof_handler (const DH &dof_handler);
/**
* Declare a data vector. The @p vector_type
* argument determines whether the data
* vector will be considered as DoF or
* cell data.
*
* This version may be called if the
* finite element presently used by the
* DoFHandler (and previously attached
* to this object) has only one component
* and therefore only one name needs to
* be given.
*/
void declare_data_vector (const std::string &name,
const VectorType vector_type);
/**
* Declare a data vector. The @p vector_type
* argument determines whether the data
* vector will be considered as DoF or
* cell data.
*
* This version must be called if the
* finite element presently used by the
* DoFHandler (and previously attached
* to this object) has more than one
* component and therefore more than one
* name needs to be given. However, you
* can also call this function with a
* <tt>vector<string></tt> containing only one
* element if the finite element has
* only one component.
*/
void declare_data_vector (const std::vector<std::string> &name,
const VectorType vector_type);
/**
* Add a data vector for the presently
* set value of the parameter.
*
* This version may be called if the
* finite element presently used by the
* DoFHandler (and previously attached
* to this object) has only one component
* and therefore only one name needs to
* be given.
*
* If @p vec is a vector with
* multiple components this
* function will generate
* distinct names for all
* components by appending an
* underscore and the number of
* each component to @p name
*
* The data vector must have been
* registered using the @p declare_data_vector
* function before actually using it the
* first time.
*
* Note that a copy of this vector is
* stored until @p finish_parameter_value
* is called the next time, so if you are
* short of memory you may want to call
* this function only after all
* computations involving large matrices
* are already done.
*/
template <typename number>
void add_data_vector (const Vector<number> &vec,
const std::string &name);
/**
* Add a data vector for the presently
* set value of the parameter.
*
* This version must be called if the
* finite element presently used by the
* DoFHandler (and previously attached
* to this object) has more than one
* component and therefore more than one
* name needs to be given. However, you
* can also call this function with a
* <tt>vector<string></tt> containing only one
* element if the finite element has
* only one component.
*
* The data vector must have been
* registered using the @p declare_data_vector
* function before actually using it the
* first time.
*
* Note that a copy of this vector is
* stored until @p finish_parameter_value
* is called the next time, so if you are
* short of memory you may want to call
* this function only after all
* computations involving large matrices
* are already done.
*/
template <typename number>
void add_data_vector (const Vector<number> &vec,
const std::vector<std::string> &names);
/**
* Actually build the patches for output
* by the base classes from the data
* stored in the data vectors and using
* the previously attached DoFHandler
* object.
*
* By @p n_subdivisions you can decide
* into how many subdivisions (in each
* space and parameter direction) each
* patch is divided. This is useful
* if higher order elements are used.
* Note however, that the number of
* subdivisions in parameter direction
* is always the same as the one is space
* direction for technical reasons.
*/
void build_patches (const unsigned int n_subdivisions = 0);
/**
* Release all data that is no
* more needed once @p build_patches
* was called and all other transactions
* for a given parameter value are done.
*
* Couterpart of @p new_parameter_value.
*/
void finish_parameter_value ();
/**
* Clear all data presently stored
* in this object.
*/
void clear ();
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
std::size_t memory_consumption () const;
/**
* Exception
*/
DeclException0 (ExcNoDoFHandlerSelected);
/**
* Exception
*/
DeclException3 (ExcInvalidVectorSize,
int, int, int,
<< "The vector has size " << arg1
<< " but the DoFHandler objects says there are " << arg2
<< " degrees of freedom and there are " << arg3
<< " active cells.");
/**
* Exception
*/
DeclException2 (ExcInvalidCharacter,
std::string, size_t,
<< "Please use only the characters [a-zA-Z0-9_<>()] for" << std::endl
<< "description strings since some graphics formats will only accept these."
<< std::endl
<< "The string you gave was <" << arg1
<< ">, the invalid character is <" << arg1[arg2]
<< ">." << std::endl);
/**
* Exception
*/
DeclException2 (ExcInvalidNumberOfNames,
int, int,
<< "You have to give one name per component in your "
<< "data vector. The number you gave was " << arg1
<< ", but the number of components is " << arg2);
/**
* Exception
*/
DeclException1 (ExcVectorNotDeclared,
std::string,
<< "The data vector for which the first component has the name "
<< arg1 << " has not been declared before.");
/**
* Exception
*/
DeclException0 (ExcDataNotCleared);
/**
* Exception
*/
DeclException0 (ExcDataAlreadyAdded);
/**
* Exception
*/
DeclException1 (ExcNameAlreadyUsed,
std::string,
<< "You tried to declare a component of a data vector with "
<< "the name <" << arg1 << ">, but that name is already used.");
/**
* Exception
*/
DeclException1 (ExcInvalidNumberOfSubdivisions,
int,
<< "The number of subdivisions per patch, " << arg1
<< ", is not valid.");
private:
/**
* Present parameter value.
*/
double parameter;
/**
* Present parameter step, i.e.
* length of the parameter interval
* to be written next.
*/
double parameter_step;
/**
* DoF handler to be used for the data
* corresponding to the present parameter
* value.
*/
SmartPointer<const DH,DataOutStack<dim,spacedim,DH> > dof_handler;
/**
* List of patches of all past and
* present parameter value data sets.
*/
std::vector< dealii::DataOutBase::Patch<dim+1,dim+1> > patches;
/**
* Structure holding data vectors
* (cell and dof data) for the present
* parameter value.
*/
struct DataVector
{
/**
* Data vector.
*/
Vector<double> data;
/**
* Names of the different components
* within each such data set.
*/
std::vector<std::string> names;
/**
* Determine an estimate for
* the memory consumption (in
* bytes) of this object.
*/
std::size_t memory_consumption () const;
};
/**
* List of DoF data vectors.
*/
std::vector<DataVector> dof_data;
/**
* List of cell data vectors.
*/
std::vector<DataVector> cell_data;
/**
* This is the function through
* which derived classes propagate
* preprocessed data in the form of
* Patch structures (declared in
* the base class DataOutBase) to
* the actual output function.
*/
virtual const std::vector< dealii::DataOutBase::Patch<dim+1,dim+1> > & get_patches () const;
/**
* Virtual function through
* which the names of data sets are
* obtained by the output functions
* of the base class.
*/
virtual std::vector<std::string> get_dataset_names () const;
};
DEAL_II_NAMESPACE_CLOSE
#endif
|