Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
initial_conditions.cc
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2019, 2021-2023, 2026 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#include <core/utilities.h>
5
7
8namespace Parameters
9{
10 void
11 Ramp_n::declare_parameters(ParameterHandler &prm)
12 {
13 prm.enter_subsection("n");
14 {
15 prm.declare_entry(
16 "initial n",
17 Patterns::Tools::Convert<double>::to_string(n_init),
18 Patterns::Double(),
19 "First n value with which to start the initial condition");
20
21 prm.declare_entry(
22 "iterations",
23 Patterns::Tools::Convert<int>::to_string(n_iter),
24 Patterns::Integer(0),
25 "Number of iterations used in the ramp before reaching the final n value");
26
27 prm.declare_entry("alpha",
28 Patterns::Tools::Convert<double>::to_string(alpha),
29 Patterns::Double(),
30 "Coefficient used for n-spacing.");
31 }
32 prm.leave_subsection();
33 }
34
35 void
36 Ramp_n::parse_parameters(ParameterHandler &prm)
37 {
38 prm.enter_subsection("n");
39 {
40 n_init = prm.get_double("initial n");
41 n_iter = prm.get_integer("iterations");
42 alpha = prm.get_double("alpha");
43 }
44 prm.leave_subsection();
45 }
46
47 void
49 {
50 prm.enter_subsection("kinematic viscosity");
51 {
52 prm.declare_entry(
53 "initial kinematic viscosity",
54 Patterns::Tools::Convert<double>::to_string(kinematic_viscosity_init),
55 Patterns::Double(),
56 "First kinematic viscosity value with which to start the initial condition");
57
58 prm.declare_entry(
59 "iterations",
60 Patterns::Tools::Convert<int>::to_string(n_iter),
61 Patterns::Integer(),
62 "Number of iterations used in the ramp before reaching the final kinematic viscosity value");
63
64 prm.declare_entry("alpha",
65 Patterns::Tools::Convert<double>::to_string(alpha),
66 Patterns::Double(),
67 "Coefficient used for kinematic viscosity-spacing.");
68 }
69 prm.leave_subsection();
70 }
71
72 void
73 Ramp_viscosity::parse_parameters(ParameterHandler &prm)
74 {
75 prm.enter_subsection("kinematic viscosity");
76 {
77 kinematic_viscosity_init = prm.get_double("initial kinematic viscosity");
78 n_iter = prm.get_integer("iterations");
79 alpha = prm.get_double("alpha");
80 }
81 prm.leave_subsection();
82 }
83
84 void
85 Ramp::declare_parameters(ParameterHandler &prm)
86 {
87 prm.enter_subsection("ramp");
88 {
89 ramp_n.declare_parameters(prm);
90 ramp_viscosity.declare_parameters(prm);
91 }
92 prm.leave_subsection();
93 }
94
95 void
96 Ramp::parse_parameters(ParameterHandler &prm)
97 {
98 prm.enter_subsection("ramp");
99 {
100 ramp_n.parse_parameters(prm);
101 ramp_viscosity.parse_parameters(prm);
102 }
103 prm.leave_subsection();
104 }
105
106 template <int dim>
107 void
109 {
110 prm.enter_subsection("initial conditions");
111 {
112 declare_enum_entry(prm, "type", type, "Type of initial condition.");
113 prm.enter_subsection("uvwp");
114 uvwp.declare_parameters(prm, dim + 1);
115 prm.leave_subsection();
116
117 prm.declare_entry("kinematic viscosity",
118 Patterns::Tools::Convert<double>::to_string(
120 Patterns::Double(),
121 "Kinematic viscosity for viscous initial conditions");
122
123
124 prm.enter_subsection("temperature");
125 temperature.declare_parameters(prm);
126 prm.leave_subsection();
127
128 prm.enter_subsection("tracer");
129 tracer.declare_parameters(prm);
130 prm.leave_subsection();
131
132 prm.enter_subsection("CLS");
133 CLS.declare_parameters(prm);
135 prm,
136 "smoothing type",
138 "Apply a projection step with diffusion to smooth the CLS initial condition.");
139
140 prm.declare_entry(
141 "diffusion factor",
142 Patterns::Tools::Convert<double>::to_string(
144 Patterns::Double(),
145 "Factor applied to the diffusion term in the projection step");
146 prm.leave_subsection();
147
148 prm.enter_subsection("QMOM");
150 prm.leave_subsection();
151
152 prm.enter_subsection("cahn hilliard");
153 cahn_hilliard.declare_parameters(prm, 2);
154 prm.leave_subsection();
155
156 prm.enter_subsection("electromagnetics");
157 electromagnetics.declare_parameters(prm, 4 * dim);
158 prm.leave_subsection();
159
160 prm.enter_subsection("average velocity profile");
161 prm.declare_entry(
162 "checkpoint folder",
164 Patterns::FileName(),
165 "the path leading to the checkpointed average velocity profile");
166 prm.declare_entry("checkpoint file name",
168 Patterns::FileName(),
169 "checkpoint file name");
170 prm.leave_subsection();
171
172 ramp.declare_parameters(prm);
173 }
174 prm.leave_subsection();
175 }
176
177 template <int dim>
178 void
180 {
181 prm.enter_subsection("initial conditions");
182 {
184
185 kinematic_viscosity = prm.get_double("kinematic viscosity");
186 prm.enter_subsection("uvwp");
187 uvwp.parse_parameters(prm);
188 prm.leave_subsection();
189
190 prm.enter_subsection("temperature");
191 temperature.parse_parameters(prm);
192 prm.leave_subsection();
193
194 prm.enter_subsection("tracer");
195 tracer.parse_parameters(prm);
196 prm.leave_subsection();
197
198 prm.enter_subsection("CLS");
199 {
200 CLS.parse_parameters(prm);
202 string_to_enum<CLSInitialConditionType>(prm.get("smoothing type"));
203
204 projection_step_diffusion_factor = prm.get_double("diffusion factor");
205 }
206 prm.leave_subsection();
207
208 prm.enter_subsection("QMOM");
209 qmom.parse_parameters(prm);
210 prm.leave_subsection();
211
212 ramp.parse_parameters(prm);
213
214 prm.enter_subsection("cahn hilliard");
215 cahn_hilliard.parse_parameters(prm);
216 prm.leave_subsection();
217
218 prm.enter_subsection("electromagnetics");
219 electromagnetics.parse_parameters(prm);
220 prm.leave_subsection();
221
222 prm.enter_subsection("average velocity profile");
223 average_velocity_folder = prm.get("checkpoint folder");
224 average_velocity_file_name = prm.get("checkpoint file name");
225
226 prm.leave_subsection();
227 }
228 prm.leave_subsection();
229 }
230
231
232 template class InitialConditions<2>;
233 template class InitialConditions<3>;
234} // namespace Parameters
CLSInitialConditionType cls_initial_condition_smoothing
FluidDynamicsInitialConditionType type
Functions::ParsedFunction< dim > electromagnetics
Functions::ParsedFunction< dim > temperature
Functions::ParsedFunction< dim > uvwp
void declare_parameters(ParameterHandler &prm)
Declares initial-condition parameters.
Functions::ParsedFunction< dim > CLS
void parse_parameters(ParameterHandler &prm)
Parses initial-condition parameters.
Functions::ParsedFunction< dim > tracer
Functions::ParsedFunction< dim > cahn_hilliard
EnumType string_to_enum(const std::string &name)
Return the enumerator whose identifier is name, e.g. to parse the value of a parameter entry into its...
Definition utilities.h:734
void declare_enum_entry(ParameterHandler &prm, const std::string &entry_name, const EnumType default_value, const std::string &description, const DeprecatedEnumNames< EnumType > &deprecated_names={}, const std::vector< EnumType > &allowed_values={})
Declare a parameter entry whose value is an enumerator. The default value, the accepted values and th...
Definition utilities.h:888
static void declare_parameters(ParameterHandler &prm)
Declare the "scalars" and "distribution" subsections in the current subsection. All the functions are...
void declare_parameters(ParameterHandler &prm)
Declares parameters for the ramped power-law exponent.
void parse_parameters(ParameterHandler &prm)
Parses parameters for the ramped power-law exponent.
void parse_parameters(ParameterHandler &prm)
Parses parameters for the ramped kinematic viscosity.
void declare_parameters(ParameterHandler &prm)
Declares parameters for the ramped kinematic viscosity.
Ramp_viscosity ramp_viscosity
void declare_parameters(ParameterHandler &prm)
Declares parameters for all ramp functions.
void parse_parameters(ParameterHandler &prm)
Parses parameters for all ramp functions.