Reference documentation for deal.II version GIT relicensing-1270-gf9b74e2b83 2024-07-23 21:30:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Member Functions | Public Attributes | List of all members
TimeStepBase_Tria_Flags::Flags< dim > Struct Template Reference

#include <deal.II/numerics/time_dependent.h>

Public Member Functions

 Flags ()
 Flags (const bool delete_and_rebuild_tria, const unsigned int wakeup_level_to_build_grid, const unsigned int sleep_level_to_delete_grid)

Public Attributes

const bool delete_and_rebuild_tria
const unsigned int wakeup_level_to_build_grid
const unsigned int sleep_level_to_delete_grid

Detailed Description

template<int dim>
struct TimeStepBase_Tria_Flags::Flags< dim >

This structure is used to tell the TimeStepBase_Tria() class how grids should be handled. It has flags defining the moments where grids shall be re-made and when they may be deleted. Also, one variable states whether grids should be kept in memory or should be deleted between to uses to save memory.

Definition at line 963 of file time_dependent.h.

Constructor & Destructor Documentation

◆ Flags() [1/2]

template<int dim>
TimeStepBase_Tria_Flags::Flags< dim >::Flags ( )

Default constructor; yields an exception, so is not really usable.

Definition at line 1161 of file

◆ Flags() [2/2]

template<int dim>
TimeStepBase_Tria_Flags::Flags< dim >::Flags ( const bool  delete_and_rebuild_tria,
const unsigned int  wakeup_level_to_build_grid,
const unsigned int  sleep_level_to_delete_grid 

Constructor; see the different fields for a description of the meaning of the parameters.

Definition at line 1172 of file

Member Data Documentation

◆ delete_and_rebuild_tria

template<int dim>
const bool TimeStepBase_Tria_Flags::Flags< dim >::delete_and_rebuild_tria

This flag determines whether the sleep and wake_up functions shall delete and rebuild the triangulation. While for small problems, this is not necessary, for large problems it is indispensable to save memory. The reason for this is that there may be several hundred time levels in memory, each with its own triangulation, which may require large amounts if there are many cells on each. Having a total of 100.000.000 cells on all time levels taken together is not uncommon, which makes this flag understandable.

Definition at line 988 of file time_dependent.h.

◆ wakeup_level_to_build_grid

template<int dim>
const unsigned int TimeStepBase_Tria_Flags::Flags< dim >::wakeup_level_to_build_grid

This number denotes the parameter to the wake_up function at which it shall rebuild the grid. Obviously, it shall be less than or equal to the look_ahead number passed to the time step management object; if it is equal, then the grid is rebuilt the first time the wake_up function is called. If delete_and_rebuild_tria is false, this number has no meaning.

Definition at line 998 of file time_dependent.h.

◆ sleep_level_to_delete_grid

template<int dim>
const unsigned int TimeStepBase_Tria_Flags::Flags< dim >::sleep_level_to_delete_grid

This is the opposite flag to the one above: it determines at which call to * sleep the grid shall be deleted.

Definition at line 1004 of file time_dependent.h.

The documentation for this struct was generated from the following files: