/usr/include/deal.II/numerics/point_value_history.h is in libdeal.ii-dev 6.3.1-1.1.
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 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 | //---------------------------------------------------------------------------
// $Id: point_value_history.h 19894 2009-10-15 22:19:51Z kanschat $
// Version: $Name$
//
// Copyright (C) 2009 by Michael Rapson and the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __dealii__point_value_history_h
#define __dealii__point_value_history_h
#include <dofs/dof_handler.h>
#include <base/point.h>
#include <lac/vector.h>
#include <dofs/dof_accessor.h>
#include <base/exceptions.h>
#include <base/quadrature_lib.h>
#include <fe/fe_q.h>
#include <fe/mapping.h>
#include <fe/mapping_q1.h>
#include <fe/fe_values.h>
#include <base/smartpointer.h>
#include <base/utilities.h>
#include <vector>
#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <map>
DEAL_II_NAMESPACE_OPEN
namespace internal
{
namespace PointValueHistory
{
template <int dim> class PointGeometryData;
}
}
namespace internal
{
namespace PointValueHistory
{
/**
* A class that stores the data needed
* to reference the support points
* closest to one requested point.
*/
template <int dim>
class PointGeometryData
{
public:
PointGeometryData(const std::vector <Point <dim> > &new_locations,
const std::vector <int> &new_sol_indices);
std::vector <Point <dim> > locations;
std::vector <int> solution_indices;
};
}
}
/**
* PointValueHistory tackles the overhead of plotting time (or any other
* iterative process) graphs of solution values at specific points on the
* mesh. The user specifies the points which the solution should be monitored
* at ahead of time, as well as giving each solution vector that they want to
* record a mnemonic name. Then for each step the user 'pushes back' the data
* available from that time step and the class extracts data for the requested
* points to store it. Finally once the computation is finished, the user can
* request Gnuplot output files to be generated.
*
* The user can store extra variables which do not relate to mesh location by
* the parameter by specifying n_independent_variables. The class then expects
* a std::vector of size n_independent_variables to be added during each step
* using the method @p push_back_independent. This may be used for example for
* recording external input, logging solver performance data such as time
* taken to solve the step and solver steps before convergence, or saving
* norms calculated.
*
* Currently the code selects the nearest support points to a given point to
* extract data from. This makes the code run at each time step very short,
* since looping over the mesh to extract the needed dof_index can be done
* just once at the start. However this does lead to problems when
* FiniteElements which do not assign dofs to actual mesh locations are used
* (i.e. FEs without support points). The Functions::FEFieldFunction class
* allows users to evaluate a solution at any point in a domain and will work
* even for FEs without support points. This functionality is not currently
* offered through this class since it has more overhead per iteration than
* the approach implemented, but this class can be extended to offer it.
*
* Following is a little code snippet that shows a common usage of this class:
*
* @code
* #include <numerics/point_value_history.h>
* //....
*
* //... code to setup Triangulation, perform any refinement necessary
* // and setup DoFHandler, sizing solution Vectors etc
*
* // call the constructor
* unsigned int n_inputs = 1; // just one independent value, which happens to be an input
* PointValueHistory<dim> node_monitor(dof_handler, n_inputs);
*
* // setup fields and points required
* node_monitor.add_field_name("Solution");
* std::vector <Point <dim> > point_vector(2);
* point_vector[0] = Point <dim>(0, 0);
* point_vector[1] = Point <dim>(0.25, 0);
* node_monitor.add_points(point_vector); // multiple points at once
* node_monitor.add_point(Point<dim>(1, 0.2)); // add a single point
* node_monitor.close(); // close the class once the setup is complete
* node_monitor.status(std::cout); // print out status to check if desired
*
* // ... more code ...
*
* // ... in an iterative loop ...
* // double time, vector <double> with size 1 input_value,
* // and Vector <double> solution calculated in the loop
* node_monitor.start_new_dataset(time);
* node_monitor.push_back_independent(input_value);
* node_monitor.evaluate_field("Solution", solution);
*
* // ... end of iterative loop ...
*
* node_monitor.write_gnuplot("node"); // write out data files
*
* @endcode
*/
template <int dim>
class PointValueHistory
{
public:
/**
* Provide a stripped down instance of
* the class which does not support
* adding points or mesh data. This may
* be used for example for recording
* external input or logging solver
* performance data.
*/
PointValueHistory (const unsigned int n_independent_variables = 0);
/**
* Constructor linking the class to a
* specific @p DoFHandler. Since this
* class reads specific data from the @p
* DoFHandler and stores it internally
* for quick access (in particular dof
* indices of closest neighbors to
* requested points) the class is fairly
* intolerant to changes to the @p
* DoFHandler. Mesh refinement and @p
* DoFRenumbering methods should be
* performed before the @p add_points
* method is called and adaptive grid
* refinement is not supported (unless it
* is completed before points are added).
* Changes to the @p DoFHandler are
* tested for by looking for a change in
* the number of dofs, which may not
* always occur so the user must be aware
* of these limitations.
*
* The user can store extra variables
* which do not relate to mesh location
* by specifying the number required
* using n_independent_variables and
* making calls to @p
* push_back_independent as needed. This
* may be used for example for recording
* external input or logging solver
* performance data.
*/
PointValueHistory (const DoFHandler<dim> & dof_handler,
const unsigned int n_independent_variables = 0);
/**
* Copy constructor explicitly provided,
* although default copy operator would
* be sufficient. This constructor can
* be safely called with a @p
* PointValueHistory object that contains
* data, but this could be expensive and
* should be avoided.
*/
PointValueHistory (const PointValueHistory & point_value_history);
/**
* Assignment operator explicitly
* provided, although default assignment
* operator would be sufficient. This
* assignment operator can be safely
* called once the class is closed and
* data added, but this is provided
* primarily to allow a @p
* PointValueHistory object declared in a
* class to be reinitialized later in the
* class. Using the assignment operator
* when the object contains data could be
* expensive.
*/
PointValueHistory & operator=(const PointValueHistory & point_value_history);
/**
Deconstructor.
*/
~PointValueHistory ();
/**
* Add a single point to the class. The
* support points (one per component) in
* the mesh that are closest to that
* point is found and its details stored
* for use when @p evaluate_field is
* called. If more than one point is
* required rather used the @p add_points
* method since this minimizes iterations
* over the mesh.
*/
void add_point(const Point <dim> & location);
/**
* Add multiple points to the class. The
* support points (one per component) in
* the mesh that are closest to that
* point is found and its details stored
* for use when @p evaluate_field is
* called. If more than one point is
* required rather call this method as it
* is more efficient than the add_points
* method since it minimizes iterations
* over the mesh. The points are added to
* the internal database in the order
* they appear in the list and there is
* always a one to one correspondence
* between the requested point and the
* added point, even if a point is
* requested multiple times.
*/
void add_points (const std::vector <Point <dim> > & locations);
/**
* Put another mnemonic string (and hence
* @p VECTOR) into the class. This also
* adds extra entries for points that are
* already in the class, so @p
* add_field_name and @p add_points can
* be called in any order.
*/
void add_field_name(const std::string &vector_name);
/**
* Extract values at the stored points
* from the VECTOR supplied and add them
* to the new dataset in vector_name. If
* a @p DoFHandler is used, this method
* must be called for each dataset (time
* step, iteration, etc) for each
* vector_name, otherwise a @p
* ExcDataLostSync error can occur.
*/
template <class VECTOR>
void evaluate_field(const std::string &vector_name, const VECTOR & solution);
/**
* Add the key for the current dataset to
* the dataset. Although calling this
* method first is sensible, the order in
* which this method, @p evaluate_field
* and @p push_back_independent is not
* important. It is however important
* that all the data for a give dataset
* is added to each dataset and that it
* is added before a new data set is
* started. This prevents a @p
* ExcDataLostSync.
*/
void start_new_dataset(double key);
/**
* If independent values have been set
* up, this method stores these
* values. This should only be called
* once per dataset, and if independent
* values are used it must be called for
* every dataset. A @p ExcDataLostSync
* exception can be thrown if this method
* is not called.
*/
void push_back_independent(const std::vector <double> &independent_values);
/**
* Write out a series of .gpl files named
* base_name + "-00.gpl", base_name +
* "-01.gpl" etc. The data file gives
* info about where the support points
* selected and interpreting the data.
* If @p n_indep != 0 an additional file
* base_name + "_indep.gpl" containing
* key and independent data. The file
* name agrees with the order the points
* were added to the class.
*/
void write_gnuplot(const std::string &base_name);
/**
* Return a @p Vector with the indices of
* selected points flagged with a 1. This
* method is mainly for testing and
* verifying that the class is working
* correctly. By passing this vector to a
* DataOut object, the user can verify
* that the positions returned by @p
* PointValueHistory< dim >::get_points
* agree with the positions that @p
* DataOut interprets from the @p Vector
* returned. The code snippet below
* demonstrates how this could be done:
* @code
* // Make a DataOut object and attach the dof_handler
* DataOut<dim> data_out;
* data_out.attach_dof_handler(dof_handler);
*
* // Call the mark_locations method to get the vector with indices flagged
* Vector<double> node_locations = node_monitor.mark_locations();
*
* // Add the vector to the data_out object and write out a file in the usual way
* data_out.add_data_vector(node_locations, "Monitor_Locations");
* data_out.build_patches(2);
* std::ofstream output("locations.gpl");
* data_out.write_gnuplot(output);
* @endcode
*/
Vector<double> mark_locations();
/**
* Stores the actual location of each
* support point selected by the @p
* add_point(s) method. This can be used
* to compare with the point requested,
* for example by using the @p
* Point<dim>::distance function. For
* convenience, location is resized to
* the correct number of points by the
* method.
*/
void get_points (std::vector <std::vector<Point <dim> > > & locations);
/**
* Once datasets have been added to the
* class, requests to add additional
* points will make the data
* interpretation unclear. The boolean @p
* closed defines a state of the class
* and ensures this does not
* happen. Additional points or vectors
* can only be added while the class is
* not closed, and the class must be
* closed before datasets can be added or
* written to file. @p
* PointValueHistory::get_points and @p
* PointValueHistory::status do not
* require the class to be closed. If a
* method that requires a class to be
* open or close is called while in the
* wrong state a @p ExcInvalidState
* exception is thrown.
*/
void close();
/**
* Delete the lock this object has to the
* @p DoFHandler used the last time the
* class was created. This method should
* not normally need to be called, but
* can be useful to ensure that the @p
* DoFHandler is released before it goes
* out of scope if the @p
* PointValueHistory class might live
* longer than it. Once this method has
* been called, the majority of methods
* will throw a @p ExcInvalidState
* exception, so if used this method
* should be the last call to the class.
*/
void clear();
/**
* Print useful debugging information
* about the class, include details about
* which support points were selected for
* each point and sizes of the data
* stored.
*/
void status(std::ostream &out);
/**
* Check the internal data sizes to test
* for a loss of data sync. This is often
* used in @p Assert statements with the
* @p ExcDataLostSync exception. If @p
* strict is @p false this method returns
* @p true if all sizes are within 1 of
* each other (needed to allow data to be
* added), with @p strict = @p true they
* must be exactly equal.
*/
bool deep_check (bool strict);
/**
* A call has been made to @p
* push_back_independent when no
* independent values were requested.
*/
DeclException0(ExcNoIndependent);
/**
* This error is thrown to indicate that
* the data sets appear to be out of
* sync. The class requires that the
* number of dataset keys is the same as
* the number of independent values sets
* and mesh linked value sets. The number
* of each of these is allowed to differ
* by one to allow new values to be added
* with out restricting the order the
* user choses to do so. Special cases
* of no @p DoFHandler and no independent
* values should not trigger this error.
*/
DeclException0(ExcDataLostSync);
/**
* A method which requires access to a @p
* DoFHandler to be meaningful has been
* called when @p n_dofs is reported to
* be zero (most likely due to default
* constructor being called). Only
* independent variables may be logged
* with no DoFHandler.
*/
DeclException0(ExcDoFHandlerRequired);
/**
* @p n_dofs for the @p DoFHandler has
* changed since the constructor was
* called. Possibly the mesh has been
* refined in some way. This suggests
* that the internal dof indices stored
* are no longer meaningful.
*/
DeclException2(ExcDoFHandlerChanged,
int,
int,
<< "Original n_dofs (" << arg1 << ") != current n_dofs (" << arg2 << ")");
private:
/**
* Stores keys, values on the abscissa.
* This will often be time, but possibly
* time step, iteration etc.
*/
std::vector <double> dataset_key;
/**
* Values that do not depend on grid
* location.
*/
std::vector <std::vector <double> > independent_values;
/**
* Saves data for each mnemonic entry.
* data_store: mnemonic -> [component]
* [key]
*/
std::map <std::string, std::vector <std::vector <double> > > data_store;
/**
* Saves the location and other mesh info
* about support points.
*/
std::vector <internal::PointValueHistory::PointGeometryData <dim> >
point_geometry_data;
/**
* A tempory pair used when adding to
* @p data_store.
*/
std::pair<std::string, std::vector <std::vector <double> > > pair_data; // could possibly be removed
/**
* Used to enforce @p closed state for some
* methods.
*/
bool closed;
/**
* Used to enforce @p !cleared state for
* some methods.
*/
bool cleared;
/**
* A smart pointer to the dof_handler
* supplied to the constructor. This can be
* released by calling @p clear().
*/
SmartPointer<const DoFHandler<dim>,PointValueHistory<dim> > dof_handler;
/**
* Variable to check that number of dofs
* in the dof_handler does not change.
*/
/* A cheap way to check that the
* triangulation has not been refined in
* anyway since the class was set up.
* Refinement will invalidate stored dof
* indices linked to support points.
*/
unsigned int n_dofs;
/**
* Stores the number of independent
* variables requested.
*/
unsigned int n_indep;
};
DEAL_II_NAMESPACE_CLOSE
#endif /* __dealii__point_value_history_h */
|