Doxygen API reference documentation for ideal.II
slab_tria.hh
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2022 - 2023 by the ideal.II authors
4 //
5 // This file is part of the ideal.II library.
6 //
7 // The ideal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 3.0 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of ideal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef INCLUDE_IDEAL_II_DISTRIBUTED_SLAB_TRIA_HH_
17 #define INCLUDE_IDEAL_II_DISTRIBUTED_SLAB_TRIA_HH_
18 
19 #include <deal.II/base/config.h>
20 
21 #ifdef DEAL_II_WITH_MPI
22 # include <deal.II/distributed/tria.h>
23 
24 # include <list>
25 # include <memory>
26 
28 {
36  template <int dim>
38  {
39  public:
49  std::shared_ptr<dealii::parallel::distributed::Triangulation<dim>>
50  space_tria,
51  double startpoint,
52  double endpoint);
53 
54 
65  std::shared_ptr<dealii::parallel::distributed::Triangulation<dim>>
66  space_tria,
67  std::vector<double> step_sizes,
68  double startpoint,
69  double endpoint);
70 
87  std::shared_ptr<dealii::parallel::distributed::Triangulation<dim>>
89 
93  std::shared_ptr<dealii::Triangulation<1>>
95 
99  double
101 
105  double
107 
117  void
118  update_temporal_triangulation(std::vector<double> step_sizes,
119  double startpoint,
120  double endpoint);
121 
122  private:
123  std::shared_ptr<dealii::parallel::distributed::Triangulation<dim>>
124  _spatial_tria;
125  std::shared_ptr<dealii::Triangulation<1>> _temporal_tria;
126  double _startpoint;
127  double _endpoint;
128  };
129 
133  template <int dim>
134  using TriaIterator = typename std::list<Triangulation<dim>>::iterator;
135 } // namespace idealii::slab::parallel::distributed
136 #endif
137 #endif /* INCLUDE_IDEAL_II_DISTRIBUTED_SLAB_TRIA_HH_ */
Actual Triangulation for a specific slab with an MPI distributed spatial mesh.
Definition: slab_tria.hh:38
void update_temporal_triangulation(std::vector< double > step_sizes, double startpoint, double endpoint)
Change the temporal triangulation to the given division.
Triangulation(std::shared_ptr< dealii::parallel::distributed::Triangulation< dim >> space_tria, std::vector< double > step_sizes, double startpoint, double endpoint)
Construct an object with a given spatial triangulation and a given division of elements in time.
std::shared_ptr< dealii::Triangulation< 1 > > temporal()
The underlying temporal triangulation.
std::shared_ptr< dealii::parallel::distributed::Triangulation< dim > > spatial()
The underlying spatial triangulation.
Triangulation(const Triangulation &other)
(shallow) copy constructor. Only the values for the start- and endpoint are actually copied....
double endpoint()
The endpoint of the temporal triangulation.
double startpoint()
The startpoint of the temporal triangulation.
Triangulation(std::shared_ptr< dealii::parallel::distributed::Triangulation< dim >> space_tria, double startpoint, double endpoint)
Construct an object with a given spatial triangulation and a single element in time.
Namespace where the processor local triangulations share a common coarse object.
Definition: idealii.hh:43
typename std::list< Triangulation< dim > >::iterator TriaIterator
A shortened type for Iterators over a list of shared pointers to Triangulation<dim> objects.
Definition: slab_tria.hh:134