ASPECT
initial_composition.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2013 - 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 
22 #ifndef _aspect_boundary_composition_initial_composition_h
23 #define _aspect_boundary_composition_initial_composition_h
24 
28 
29 
30 namespace aspect
31 {
32  namespace BoundaryComposition
33  {
42  template <int dim>
43  class InitialComposition : public Interface<dim>, public SimulatorAccess<dim>
44  {
45  public:
54  void
55  initialize () override;
56 
63  double boundary_composition (const types::boundary_id boundary_indicator,
64  const Point<dim> &position,
65  const unsigned int compositional_field) const override;
66 
71  virtual
72  double minimal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
73 
78  virtual
79  double maximal_composition (const std::set<types::boundary_id> &fixed_boundary_ids) const;
80 
85  static
86  void
87  declare_parameters (ParameterHandler &prm);
88 
92  void
93  parse_parameters (ParameterHandler &prm) override;
94 
95  private:
101 
108  std::shared_ptr<const aspect::InitialComposition::Manager<dim>> initial_composition;
109  };
110  }
111 }
112 
113 
114 #endif
std::shared_ptr< const aspect::InitialComposition::Manager< dim > > initial_composition
void parse_parameters(ParameterHandler &prm) override
virtual double maximal_composition(const std::set< types::boundary_id > &fixed_boundary_ids) const
static void declare_parameters(ParameterHandler &prm)
double boundary_composition(const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int compositional_field) const override
virtual double minimal_composition(const std::set< types::boundary_id > &fixed_boundary_ids) const