ASPECT
uniform_box.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2015 - 2022 by the authors of the ASPECT code.
3 
4  This file is part of ASPECT.
5 
6  ASPECT is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2, or (at your option)
9  any later version.
10 
11  ASPECT is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with ASPECT; see the file LICENSE. If not see
18  <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef _aspect_particle_generator_uniform_box_h
22 #define _aspect_particle_generator_uniform_box_h
23 
25 
26 namespace aspect
27 {
28  namespace Particle
29  {
30  namespace Generator
31  {
42  template <int dim>
43  class UniformBox : public Interface<dim>
44  {
45  public:
53  void
54  generate_particles(Particles::ParticleHandler<dim> &particle_handler) override;
55 
56  // avoid -Woverloaded-virtual
57  // TODO: remove this using directive once the following deprecated
58  // function in the interface class has been removed:
59  // generate_particles(std::multimap<Particles::internal::LevelInd, Particle<dim>> &particles)
61 
65  static
66  void
67  declare_parameters (ParameterHandler &prm);
68 
72  void
73  parse_parameters (ParameterHandler &prm) override;
74 
75  private:
79  types::particle_index n_particles;
80 
85  Point<dim> P_min;
86 
92  Point<dim> P_max;
93  };
94 
95  }
96  }
97 }
98 
99 #endif
void generate_particles(Particles::ParticleHandler< dim > &particle_handler) override
void parse_parameters(ParameterHandler &prm) override
static void declare_parameters(ParameterHandler &prm)