/usr/include/deal.II/numerics/solution_transfer.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 | //---------------------------------------------------------------------------
// $Id: solution_transfer.h 20602 2010-02-13 17:44:17Z bangerth $
// Version: $Name$
//
// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by 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 __deal2__solution_transfer_h
#define __deal2__solution_transfer_h
/*---------------------------- solutiontransfer.h ----------------------*/
#include <base/config.h>
#include <base/smartpointer.h>
#include <lac/vector.h>
#include <base/exceptions.h>
#include <dofs/dof_handler.h>
#include <vector>
DEAL_II_NAMESPACE_OPEN
/**
* Transfers a discrete FE function (like a solution vector) by interpolation
* while refining and/or coarsening a grid. During interpolation the
* vector is reinitialized to the new size and filled with the interpolated
* values. This class is used in the step-15,
* step-31, and step-33 tutorial programs.
*
* <h3>Usage</h3>
*
* As the interpolation while
* coarsening is much more complicated to organize
* (see further documentation below) than interpolation while pure refinement,
* @p SolutionTransfer offers two possible usages.
* <ul>
* <li> If the grid will only be purely refined
* (i.e. not locally coarsened) then use @p SolutionTransfer as follows
* @verbatim
* SolutionTransfer<dim, double> soltrans(*dof_handler);
* // flag some cells for refinement, e.g.
* GridRefinement::refine_and_coarsen_fixed_fraction(
* *tria, error_indicators, 0.3, 0);
* // prepare the triangulation
* // for refinement,
* tria->prepare_coarsening_and_refinement();
* // tell the SolutionTransfer object
* // that we intend to do pure refinement,
* soltrans.prepare_for_pure_refinement();
* // actually execute the refinement,
* tria->execute_coarsening_and_refinement();
* // and redistribute dofs.
* dof_handler->distribute_dofs (fe);
* @endverbatim
*
* Then to proceed do
* @verbatim
* // take a copy of the solution vector
* Vector<double> solution_old(solution);
* // resize solution vector to the correct
* // size, as the @p refine_interpolate
* // function requires the vectors to be
* // of right sizes
* solution.reinit(dof_handler->n_dofs());
* // and finally interpolate
* soltrans.refine_interpolate(solution_old, solution);
* @endverbatim
*
* Although the @p refine_interpolate functions are allowed to be
* called multiple times, e.g. for interpolating several solution
* vectors, there is following possibility of interpolating several
* functions simultaneously.
* @verbatim
* vector<Vector<double> > solutions_old(n_vectors, Vector<double> (n));
* ...
* vector<Vector<double> > solutions(n_vectors, Vector<double> (n));
* soltrans.refine_interpolate(solutions_old, solutions);
* @endverbatim
* This is used in several of the tutorial programs, for example
* step-31.
*
* <li> If the grid will be refined AND coarsened
* then use @p SolutionTransfer as follows
* @verbatim
* SolutionTransfer<dim, Vector<double> > soltrans(*dof_handler);
* // flag some cells for refinement
* // and coarsening, e.g.
* GridRefinement::refine_and_coarsen_fixed_fraction(
* *tria, error_indicators, 0.3, 0.05);
* // prepare the triangulation,
* tria->prepare_coarsening_and_refinement();
* // prepare the SolutionTransfer object
* // for coarsening and refinement and give
* // the solution vector that we intend to
* // interpolate later,
* soltrans.prepare_for_coarsening_and_refinement(solution);
* // actually execute the refinement,
* tria->execute_coarsening_and_refinement ();
* // redistribute dofs,
* dof_handler->distribute_dofs (fe);
* // and interpolate the solution
* Vector<double> interpolate_solution(dof_handler->n_dofs());
* soltrans.interpolate(solution, interpolated_solution);
* @endverbatim
*
* Multiple calls to the function
* <tt>interpolate (const Vector<number> &in, Vector<number> &out)</tt>
* are NOT allowed. Interpolating several functions can be performed in one step
* by using
* <tt>void interpolate (const vector<Vector<number> >&all_in, vector<Vector<number> >&all_out) const</tt>,
* and using the respective @p prepare_for_coarsening_and_refinement function
* taking several vectors as input before actually refining and coarsening the
* triangulation (see there).
* </ul>
*
* For deleting all stored data in @p SolutionTransfer and reinitializing it
* use the <tt>clear()</tt> function.
*
* The template argument @p number denotes the data type of the vectors you want
* to transfer.
*
*
* <h3>Implementation</h3>
*
* <ul>
* <li> Solution transfer while pure refinement. Assume that we have got a
* solution vector on the current (original) grid.
* Each entry of this vector belongs to one of the
* DoFs of the discretisation. If we now refine the grid then the calling of
* DoFHandler::distribute_dofs() will change at least some of the
* DoF indices. Hence we need to store the DoF indices of all active cells
* before the refinement. A pointer for each active cell
* is used to point to the vector of these DoF indices of that cell.
* This is done by prepare_for_pure_refinement().
*
* In the function <tt>refine_interpolate(in,out)</tt> and on each cell where the
* pointer is set (i.e. the cells that were active in the original grid)
* we can now access the local values of the solution vector @p in
* on that cell by using the stored DoF indices. These local values are
* interpolated and set into the vector @p out that is at the end the
* discrete function @p in interpolated on the refined mesh.
*
* The <tt>refine_interpolate(in,out)</tt> function can be called multiple times for
* arbitrary many discrete functions (solution vectors) on the original grid.
*
* <li> Solution transfer while coarsening and refinement. After
* calling Triangulation@p ::prepare_coarsening_and_refinement the
* coarsen flags of either all or none of the children of a
* (father-)cell are set. While coarsening
* (Triangulation@p ::execute_coarsening_and_refinement)
* the cells that are not needed any more will be deleted from the Triangulation.
*
* For the interpolation from the (to be coarsenend) children to their father
* the children cells are needed. Hence this interpolation
* and the storing of the interpolated values of each of the discrete functions
* that we want to interpolate needs to take place before these children cells
* are coarsened (and deleted!!). Again a pointers for the relevant cells is
* set to point to these values (see below).
* Additionally the DoF indices of the cells
* that will not be coarsened need to be stored according to the solution
* transfer while pure refinement (cf there). All this is performed by
* <tt>prepare_for_coarsening_and_refinement(all_in)</tt> where the
* <tt>vector<Vector<number> >vector all_in</tt> includes
* all discrete functions to be interpolated onto the new grid.
*
* As we need two different kinds of pointers (<tt>vector<unsigned int> *</tt> for the Dof
* indices and <tt>vector<Vector<number> > *</tt> for the interpolated DoF values)
* we use the @p Pointerstruct that includes both of these pointers and
* the pointer for each cell points to these @p Pointerstructs.
* On each cell only one of the two different pointers is used at one time
* hence we could use a
* <tt>void * pointer</tt> as <tt>vector<unsigned int> *</tt> at one time and as
* <tt>vector<Vector<number> > *</tt> at the other but using this @p Pointerstruct
* in between makes the use of these pointers more safe and gives better
* possibility to expand their usage.
*
* In <tt>interpolate(all_in, all_out)</tt> the refined cells are treated according
* to the solution transfer while pure refinement. Additionally, on each
* cell that is coarsened (hence previously was a father cell),
* the values of the discrete
* functions in @p all_out are set to the stored local interpolated values
* that are accessible due to the 'vector<Vector<number> > *' pointer in
* @p Pointerstruct that is pointed to by the pointer of that cell.
* It is clear that <tt>interpolate(all_in, all_out)</tt> only can be called with
* the <tt>vector<Vector<number> > all_in</tt> that previously was the parameter
* of the <tt>prepare_for_coarsening_and_refinement(all_in)</tt> function. Hence
* <tt>interpolate(all_in, all_out)</tt> can (in contrast to
* <tt>refine_interpolate(in, out)</tt>) only be called once.
* </ul>
*
* @ingroup numerics
* @author Ralf Hartmann, 1999
*/
template<int dim, typename VECTOR=Vector<double>, class DH=DoFHandler<dim> >
class SolutionTransfer
{
public:
/**
* Constructor, takes the current DoFHandler
* as argument.
*/
SolutionTransfer(const DH &dof);
/**
* Destructor
*/
~SolutionTransfer();
/**
* Reinit this class to the state that
* it has
* directly after calling the Constructor
*/
void clear();
/**
* Prepares the @p SolutionTransfer for
* pure refinement. It
* stores the dof indices of each cell.
* After calling this function
* only calling the @p refine_interpolate
* functions is allowed.
*/
void prepare_for_pure_refinement();
/**
* Prepares the @p SolutionTransfer for
* coarsening and refinement. It
* stores the dof indices of each cell and
* stores the dof values of the vectors in
* @p all_in in each cell that'll be coarsened.
* @p all_in includes all vectors
* that are to be interpolated
* onto the new (refined and/or
* coarsenend) grid.
*/
void prepare_for_coarsening_and_refinement (const std::vector<VECTOR> &all_in);
/**
* Same as previous function
* but for only one discrete function
* to be interpolated.
*/
void prepare_for_coarsening_and_refinement (const VECTOR &in);
/**
* This function
* interpolates the discrete function @p in,
* which is a vector on the grid before the
* refinement, to the function @p out
* which then is a vector on the refined grid.
* It assumes the vectors having the
* right sizes (i.e. <tt>in.size()==n_dofs_old</tt>,
* <tt>out.size()==n_dofs_refined</tt>)
*
* Calling this function is allowed only
* if @p prepare_for_pure_refinement is called
* and the refinement is
* executed before.
* Multiple calling of this function is
* allowed. e.g. for interpolating several
* functions.
*/
void refine_interpolate (const VECTOR &in,
VECTOR &out) const;
/**
* This function
* interpolates the discrete functions
* that are stored in @p all_out onto
* the refined and/or coarsenend grid.
* It assumes the vectors in @p all_in
* denote the same vectors
* as in @p all_in as parameter of
* <tt>prepare_for_refinement_and_coarsening(all_in)</tt>.
* However, there is no way of verifying
* this internally, so be careful here.
*
* Calling this function is
* allowed only if first
* Triangulation@p ::prepare_coarsening_and_refinement,
* second
* @p SolutionTransfer::prepare_for_coarsening_and_refinement,
* an then third
* Triangulation@p ::execute_coarsening_and_refinement
* are called before. Multiple
* calling of this function is
* NOT allowed. Interpolating
* several functions can be
* performed in one step.
*
* The number of output vectors
* is assumed to be the same as
* the number of input
* vectors. Also, the sizes of
* the output vectors are assumed
* to be of the right size
* (@p n_dofs_refined). Otherwise
* an assertion will be thrown.
*/
void interpolate (const std::vector<VECTOR>&all_in,
std::vector<VECTOR> &all_out) const;
/**
* Same as the previous function.
* It interpolates only one function.
* It assumes the vectors having the
* right sizes (i.e. <tt>in.size()==n_dofs_old</tt>,
* <tt>out.size()==n_dofs_refined</tt>)
*
* Multiple calling of this function is
* NOT allowed. Interpolating
* several functions can be performed
* in one step by using
* <tt>interpolate (all_in, all_out)</tt>
*/
void interpolate (const VECTOR &in,
VECTOR &out) const;
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
unsigned int memory_consumption () const;
/**
* Exception
*/
DeclException0(ExcNotPrepared);
/**
* Exception
*/
DeclException0(ExcAlreadyPrepForRef);
/**
* Exception
*/
DeclException0(ExcAlreadyPrepForCoarseAndRef);
/**
* Exception
*/
DeclException0(ExcTriaPrepCoarseningNotCalledBefore);
/**
* Exception
*/
DeclException0(ExcNoInVectorsGiven);
/**
* Exception
*/
DeclException0(ExcVectorsDifferFromInVectors);
/**
* Exception
*/
DeclException0(ExcNumberOfDoFsPerCellHasChanged);
private:
/**
* Pointer to the degree of freedom handler
* to work with.
*/
SmartPointer<const DH,SolutionTransfer<dim,VECTOR,DH> > dof_handler;
/**
* Stores the number of DoFs before the
* refinement and/or coarsening.
*/
unsigned int n_dofs_old;
/**
* Declaration of
* @p PreparationState that
* denotes the three possible
* states of the
* @p SolutionTransfer: being
* prepared for 'pure
* refinement', prepared for
* 'coarsening and refinement' or
* not prepared.
*/
enum PreparationState {
none, pure_refinement, coarsening_and_refinement
};
/**
* Definition of the respective variable.
*/
PreparationState prepared_for;
/**
* Is used for @p prepare_for_refining
* (of course also for
* @p repare_for_refining_and_coarsening)
* and stores all dof indices
* of the cells that'll be refined
*/
std::vector<std::vector<unsigned int> > indices_on_cell;
/**
* All cell data (the dof indices and
* the dof values)
* should be accessable from each cell.
* As each cell has got only one
* @p user_pointer, multiple pointers to the
* data need to be packetized in a structure.
* Note that in our case on each cell
* either the
* <tt>vector<unsigned int> indices</tt> (if the cell
* will be refined) or the
* <tt>vector<double> dof_values</tt> (if the
* children of this cell will be deleted)
* is needed, hence one @p user_pointer should
* be sufficient, but to allow some errorchecks
* and to preserve the user from making
* user errors the @p user_pointer will be
* 'multiplied' by this structure.
*/
struct Pointerstruct {
Pointerstruct();
unsigned int memory_consumption () const;
std::vector<unsigned int> *indices_ptr;
std::vector<Vector<typename VECTOR::value_type> > *dof_values_ptr;
};
/**
* Map mapping from level and index of cell
* to the @p Pointerstructs (cf. there).
* This map makes it possible to keep all
* the information needed to transfer the
* solution inside this object rather than
* using user pointers of the Triangulation
* for this purpose.
*/
std::map<std::pair<unsigned int, unsigned int>, Pointerstruct> cell_map;
/**
* Is used for
* @p prepare_for_refining_and_coarsening
* The interpolated dof values
* of all cells that'll be coarsened
* will be stored in this vector.
*/
std::vector<std::vector<Vector<typename VECTOR::value_type> > > dof_values_on_cell;
};
DEAL_II_NAMESPACE_CLOSE
/*---------------------------- solutiontransfer.h ---------------------------*/
#endif
/*---------------------------- solutiontransfer.h ---------------------------*/
|