Branch data Line data Source code
1 : : // *****************************************************************************
2 : : /*!
3 : : \file src/Control/Inciter/InputDeck/InputDeck.hpp
4 : : \copyright 2012-2015 J. Bakosi,
5 : : 2016-2018 Los Alamos National Security, LLC.,
6 : : 2019-2021 Triad National Security, LLC.
7 : : All rights reserved. See the LICENSE file for details.
8 : : \brief Inciter's new input deck definition
9 : : \details This file defines the heterogeneous struct that is used for storing
10 : : the data from user input during the control file parsing of the
11 : : computational shock hydrodynamics tool, Inciter.
12 : : */
13 : : // *****************************************************************************
14 : : #ifndef InputDeck_h
15 : : #define InputDeck_h
16 : :
17 : : #include <getopt.h>
18 : : #include "Types.hpp"
19 : : #include "TaggedTuple.hpp"
20 : : #include "Inciter/CmdLine/CmdLine.hpp"
21 : : #include "Transfer.hpp"
22 : : #include "Inciter/OutVar.hpp"
23 : : #include "Inciter/Options/PDE.hpp"
24 : : #include "Inciter/Options/Problem.hpp"
25 : : #include "Inciter/Options/Scheme.hpp"
26 : : #include "Inciter/Options/Limiter.hpp"
27 : : #include "Inciter/Options/Flux.hpp"
28 : : #include "Inciter/Options/Initiate.hpp"
29 : : #include "Inciter/Options/AMRInitial.hpp"
30 : : #include "Inciter/Options/AMRError.hpp"
31 : : #include "Inciter/Options/PrefIndicator.hpp"
32 : : #include "Inciter/Options/MeshVelocity.hpp"
33 : : #include "Inciter/Options/MeshVelocitySmoother.hpp"
34 : : #include "Inciter/Options/Material.hpp"
35 : : #include "Options/PartitioningAlgorithm.hpp"
36 : : #include "Options/TxtFloatFormat.hpp"
37 : : #include "Options/FieldFile.hpp"
38 : : #include "Options/Error.hpp"
39 : : #include "Options/UserTable.hpp"
40 : :
41 : : namespace inciter {
42 : :
43 : : namespace ctr {
44 : :
45 : : using ncomp_t = std::size_t;
46 : :
47 : : using bclist = tk::TaggedTuple< brigand::list<
48 : : tag::dirichlet, std::vector< std::size_t >,
49 : : tag::symmetry, std::vector< std::size_t >,
50 : : tag::inlet, std::vector< std::size_t >,
51 : : tag::outlet, std::vector< std::size_t >,
52 : : tag::farfield, std::vector< std::size_t >,
53 : : tag::extrapolate, std::vector< std::size_t >,
54 : : tag::noslipwall, std::vector< std::size_t >
55 : : > >;
56 : :
57 : : // Transport
58 : : using transportList = tk::TaggedTuple< brigand::list<
59 : : tag::physics, PhysicsType,
60 : : tag::ncomp, std::size_t,
61 : : tag::intsharp, int,
62 : : tag::intsharp_param, tk::real,
63 : : tag::problem, ProblemType,
64 : : tag::diffusivity, std::vector< tk::real >,
65 : : tag::lambda, std::vector< tk::real >,
66 : : tag::u0, std::vector< tk::real >
67 : : > >;
68 : :
69 : : // CompFlow
70 : : using compflowList = tk::TaggedTuple< brigand::list<
71 : : tag::physics, PhysicsType,
72 : : tag::problem, ProblemType,
73 : : tag::alpha, tk::real,
74 : : tag::beta, tk::real,
75 : : tag::betax, tk::real,
76 : : tag::betay, tk::real,
77 : : tag::betaz, tk::real,
78 : : tag::r0, tk::real,
79 : : tag::p0, tk::real,
80 : : tag::ce, tk::real,
81 : : tag::kappa, tk::real
82 : : > >;
83 : :
84 : : // MultiMat
85 : : using multimatList = tk::TaggedTuple< brigand::list<
86 : : tag::physics, PhysicsType,
87 : : tag::nmat, std::size_t,
88 : : tag::prelax, uint64_t,
89 : : tag::prelax_timescale, tk::real,
90 : : tag::intsharp, int,
91 : : tag::intsharp_param, tk::real,
92 : : tag::rho0constraint, uint64_t,
93 : : tag::dt_sos_massavg, int,
94 : : tag::problem, ProblemType,
95 : : tag::viscous, bool
96 : : > >;
97 : :
98 : : // MultiSpecies
99 : : using multispeciesList = tk::TaggedTuple< brigand::list<
100 : : tag::physics, PhysicsType,
101 : : tag::nspec, std::size_t,
102 : : tag::problem, ProblemType,
103 : : tag::viscous, bool
104 : : > >;
105 : :
106 : : // Material/EOS object
107 : : using materialList = tk::TaggedTuple< brigand::list<
108 : : tag::eos, MaterialType,
109 : : tag::id, std::vector< uint64_t >,
110 : : tag::gamma, std::vector< tk::real >,
111 : : tag::pstiff, std::vector< tk::real >,
112 : : tag::w_gru, std::vector< tk::real >,
113 : : tag::A_jwl, std::vector< tk::real >,
114 : : tag::B_jwl, std::vector< tk::real >,
115 : : tag::C_jwl, std::vector< tk::real >,
116 : : tag::R1_jwl, std::vector< tk::real >,
117 : : tag::R2_jwl, std::vector< tk::real >,
118 : : tag::rho0_jwl, std::vector< tk::real >,
119 : : tag::de_jwl, std::vector< tk::real >,
120 : : tag::rhor_jwl, std::vector< tk::real >,
121 : : tag::Tr_jwl, std::vector< tk::real >,
122 : : tag::Pr_jwl, std::vector< tk::real >,
123 : : tag::mu, std::vector< tk::real >,
124 : : tag::yield_stress, std::vector< tk::real >,
125 : : tag::cv, std::vector< tk::real >,
126 : : tag::k, std::vector< tk::real >
127 : : > >;
128 : :
129 : : // Boundary conditions block
130 : : using bcList = tk::TaggedTuple< brigand::list<
131 : : tag::mesh, std::vector< std::size_t >,
132 : : tag::dirichlet, std::vector< std::size_t >,
133 : : tag::symmetry, std::vector< std::size_t >,
134 : : tag::inlet, std::vector< std::size_t >,
135 : : tag::outlet, std::vector< std::size_t >,
136 : : tag::farfield, std::vector< std::size_t >,
137 : : tag::extrapolate, std::vector< std::size_t >,
138 : : tag::noslipwall, std::vector< std::size_t >,
139 : : tag::stag_point, std::vector< tk::real >,
140 : : tag::radius, tk::real,
141 : : tag::velocity, std::vector< tk::real >,
142 : : tag::pressure, tk::real,
143 : : tag::density, tk::real,
144 : : tag::temperature, tk::real,
145 : : tag::mass_fractions, std::vector< tk::real >,
146 : : tag::materialid, std::size_t,
147 : : tag::timedep, std::vector<
148 : : tk::TaggedTuple< brigand::list<
149 : : tag::sideset, std::vector< uint64_t >,
150 : : tag::fn, std::vector< tk::real >
151 : : > >
152 : : >
153 : : > >;
154 : :
155 : : // IC box
156 : : using boxList = tk::TaggedTuple< brigand::list<
157 : : tag::materialid, std::size_t,
158 : : tag::volume, tk::real,
159 : : tag::mass, tk::real,
160 : : tag::density, tk::real,
161 : : tag::velocity, std::vector< tk::real >,
162 : : tag::pressure, tk::real,
163 : : tag::energy, tk::real,
164 : : tag::energy_content, tk::real,
165 : : tag::temperature, tk::real,
166 : : tag::mass_fractions, std::vector< tk::real >,
167 : : tag::xmin, tk::real,
168 : : tag::xmax, tk::real,
169 : : tag::ymin, tk::real,
170 : : tag::ymax, tk::real,
171 : : tag::zmin, tk::real,
172 : : tag::zmax, tk::real,
173 : : tag::orientation, std::vector< tk::real >,
174 : : tag::initiate, inciter::ctr::InitiateType,
175 : : tag::point, std::vector< tk::real >,
176 : : tag::init_time, tk::real,
177 : : tag::front_width, tk::real,
178 : : tag::front_speed, tk::real
179 : : > >;
180 : :
181 : : // IC meshblock
182 : : using meshblockList = tk::TaggedTuple< brigand::list<
183 : : tag::blockid, std::uint64_t,
184 : : tag::materialid, std::size_t,
185 : : tag::volume, tk::real,
186 : : tag::mass, tk::real,
187 : : tag::density, tk::real,
188 : : tag::velocity, std::vector< tk::real >,
189 : : tag::pressure, tk::real,
190 : : tag::energy, tk::real,
191 : : tag::energy_content, tk::real,
192 : : tag::temperature, tk::real,
193 : : tag::mass_fractions, std::vector< tk::real >,
194 : : tag::initiate, inciter::ctr::InitiateType,
195 : : tag::point, std::vector< tk::real >,
196 : : tag::init_time, tk::real,
197 : : tag::front_width, tk::real,
198 : : tag::front_speed, tk::real
199 : : > >;
200 : :
201 : : // Initial conditions (ic) block
202 : : using icList = tk::TaggedTuple< brigand::list<
203 : : tag::materialid, std::size_t,
204 : : tag::pressure, tk::real,
205 : : tag::temperature, tk::real,
206 : : tag::mass_fractions, std::vector< tk::real >,
207 : : tag::density, tk::real,
208 : : tag::energy, tk::real,
209 : : tag::velocity, std::vector< tk::real >,
210 : : tag::box, std::vector< boxList >,
211 : : tag::meshblock, std::vector< meshblockList >
212 : : > >;
213 : :
214 : : // Overset mesh block
215 : : using meshList = tk::TaggedTuple< brigand::list<
216 : : tag::filename, std::string,
217 : : tag::location, std::vector< tk::real >,
218 : : tag::orientation, std::vector< tk::real >,
219 : : tag::velocity, std::vector< tk::real >
220 : : > >;
221 : :
222 : : // Field output block
223 : : using fieldOutputList = tk::TaggedTuple< brigand::list<
224 : : tag::interval, uint32_t,
225 : : tag::time_interval, tk::real,
226 : : tag::time_range, std::vector< tk::real >,
227 : : tag::refined, bool,
228 : : tag::filetype, tk::ctr::FieldFileType,
229 : : tag::sideset, std::vector< uint64_t >,
230 : : tag::outvar, std::vector< OutVar >,
231 : : tag::elemalias, std::vector< std::string >, // only for error checking
232 : : tag::elemvar, std::vector< std::string >, // only for error checking
233 : : tag::nodealias, std::vector< std::string >, // only for error checking
234 : : tag::nodevar, std::vector< std::string > // only for error checking
235 : : > >;
236 : :
237 : : // Diagnostics block
238 : : using diagnosticsList = tk::TaggedTuple< brigand::list<
239 : : tag::interval, uint32_t,
240 : : tag::error, tk::ctr::ErrorType,
241 : : tag::format, tk::ctr::TxtFloatFormatType,
242 : : tag::precision, std::streamsize
243 : : > >;
244 : :
245 : : // History output block
246 : : using historyOutputList = tk::TaggedTuple< brigand::list<
247 : : tag::interval, uint32_t,
248 : : tag::time_interval, tk::real,
249 : : tag::time_range, std::vector< tk::real >,
250 : : tag::format, tk::ctr::TxtFloatFormatType,
251 : : tag::precision, std::streamsize,
252 : : tag::point, std::vector<
253 : : tk::TaggedTuple< brigand::list<
254 : : tag::id, std::string,
255 : : tag::coord, std::vector< tk::real >
256 : : > >
257 : : >
258 : : > >;
259 : :
260 : : using ConfigMembers = brigand::list<
261 : :
262 : : tag::title, std::string,
263 : :
264 : : // Command line parameters
265 : : tag::cmd, CmdLine,
266 : :
267 : : // time stepping options
268 : : tag::nstep, uint64_t,
269 : : tag::term, tk::real,
270 : : tag::t0, tk::real,
271 : : tag::dt, tk::real,
272 : : tag::cfl, tk::real,
273 : : tag::ttyi, uint32_t,
274 : : tag::imex_runge_kutta, uint32_t,
275 : : tag::imex_maxiter, uint32_t,
276 : : tag::imex_reltol, tk::real,
277 : : tag::imex_abstol, tk::real,
278 : :
279 : : // steady-state solver options
280 : : tag::steady_state, bool,
281 : : tag::residual, tk::real,
282 : : tag::rescomp, uint32_t,
283 : :
284 : : // mesh partitioning and reordering/sorting choices
285 : : tag::partitioning, tk::ctr::PartitioningAlgorithmType,
286 : : tag::pelocal_reorder, bool,
287 : : tag::operator_reorder, bool,
288 : :
289 : : // discretization scheme choices
290 : : tag::scheme, SchemeType,
291 : : tag::ndof, std::size_t,
292 : : tag::rdof, std::size_t,
293 : : tag::flux, FluxType,
294 : : tag::lowspeed_kp, tk::real,
295 : :
296 : : // limiter options
297 : : tag::limiter, LimiterType,
298 : : tag::cweight, tk::real,
299 : : tag::shock_detector_coeff, tk::real,
300 : : tag::accuracy_test, bool,
301 : : tag::limsol_projection, bool,
302 : :
303 : : // PDE options
304 : : tag::ncomp, std::size_t,
305 : : tag::pde, PDEType,
306 : : tag::transport, transportList,
307 : : tag::compflow, compflowList,
308 : : tag::multimat, multimatList,
309 : : tag::multispecies, multispeciesList,
310 : :
311 : : // Dependent variable name
312 : : tag::depvar, std::vector< char >,
313 : :
314 : : tag::sys, std::map< std::size_t, std::size_t >,
315 : :
316 : : tag::material, std::vector< materialList >,
317 : :
318 : : tag::matidxmap, tk::TaggedTuple< brigand::list<
319 : : tag::eosidx, std::vector< std::size_t >,
320 : : tag::matidx, std::vector< std::size_t >,
321 : : tag::solidx, std::vector< std::size_t >
322 : : > >,
323 : :
324 : : // Conditions
325 : : tag::bc, std::vector< bcList >,
326 : : tag::ic, icList,
327 : : tag::mesh, std::vector< meshList >,
328 : : tag::transfer, std::vector< Transfer >,
329 : :
330 : : // ALE block
331 : : // ---------------------------------------------------------------------------
332 : : tag::ale, tk::TaggedTuple< brigand::list<
333 : : tag::ale, bool,
334 : : tag::smoother, MeshVelocitySmootherType,
335 : : tag::mesh_velocity, MeshVelocityType,
336 : : tag::mesh_motion, std::vector< std::size_t >,
337 : : tag::meshforce, std::vector< tk::real >,
338 : : tag::dvcfl, tk::real,
339 : : tag::vortmult, tk::real,
340 : : tag::maxit, std::size_t,
341 : : tag::tolerance, tk::real,
342 : : tag::dirichlet, std::vector< std::size_t >,
343 : : tag::symmetry, std::vector< std::size_t >,
344 : : tag::move, std::vector<
345 : : tk::TaggedTuple< brigand::list<
346 : : tag::sideset, std::vector< uint64_t >,
347 : : tag::fntype, tk::ctr::UserTableType,
348 : : tag::fn, std::vector< tk::real >
349 : : > >
350 : : >
351 : : > >,
352 : :
353 : : // p-refinement block
354 : : // ---------------------------------------------------------------------------
355 : : tag::pref, tk::TaggedTuple< brigand::list<
356 : : tag::pref, bool,
357 : : tag::indicator, PrefIndicatorType,
358 : : tag::ndofmax, std::size_t,
359 : : tag::tolref, tk::real
360 : : > >,
361 : :
362 : : // AMR block
363 : : // ---------------------------------------------------------------------------
364 : : tag::amr, tk::TaggedTuple< brigand::list<
365 : : tag::amr, bool,
366 : : tag::t0ref, bool,
367 : : tag::dtref, bool,
368 : : tag::dtref_uniform, bool,
369 : : tag::dtfreq, std::size_t,
370 : : tag::maxlevels, std::size_t,
371 : : tag::initial, std::vector< AMRInitialType >,
372 : : tag::edgelist, std::vector< std::size_t >,
373 : : tag::coords, tk::TaggedTuple< brigand::list<
374 : : tag::xminus, tk::real,
375 : : tag::xplus, tk::real,
376 : : tag::yminus, tk::real,
377 : : tag::yplus, tk::real,
378 : : tag::zminus, tk::real,
379 : : tag::zplus, tk::real
380 : : > >,
381 : : tag::error, AMRErrorType,
382 : : tag::refvar, std::vector< char >,
383 : : tag::tol_refine, tk::real,
384 : : tag::tol_derefine, tk::real
385 : : > >,
386 : :
387 : : // Output options
388 : : tag::field_output, fieldOutputList,
389 : : tag::diagnostics, diagnosticsList,
390 : : tag::history_output, historyOutputList
391 : : >;
392 : :
393 : : // Class storing the Config params
394 : : class InputDeck : public tk::TaggedTuple< ConfigMembers > {
395 : :
396 : : public:
397 : : //! Set of tags to ignore when printing this InputDeck
398 : : using ignore = CmdLine::ignore;
399 : :
400 : : //! \brief Constructor: set defaults
401 : : //! \param[in] cl Previously parsed and store command line
402 : : //! \details Anything not set here is initialized by the compiler using the
403 : : //! default constructor for the corresponding type.
404 : 1333 : explicit InputDeck( const CmdLine& cl = {} ) {
405 : : // Set previously parsed command line
406 [ + - ]: 1333 : get< tag::cmd >() = cl;
407 : : // Default time stepping params
408 : 1333 : get< tag::dt >() = 0.0;
409 : 1333 : get< tag::cfl >() = 0.0;
410 : : // Default AMR settings
411 : 1333 : auto rmax =
412 : : std::numeric_limits< tk::real >::max() / 100;
413 : 1333 : get< tag::amr, tag::coords, tag::xminus >() = rmax;
414 : 1333 : get< tag::amr, tag::coords, tag::xplus >() = -rmax;
415 : 1333 : get< tag::amr, tag::coords, tag::yminus >() = rmax;
416 : 1333 : get< tag::amr, tag::coords, tag::yplus >() = -rmax;
417 : 1333 : get< tag::amr, tag::coords, tag::zminus >() = rmax;
418 : 1333 : get< tag::amr, tag::coords, tag::zplus >() = -rmax;
419 : :
420 : : // -----------------------------------------------------------------------
421 : : /*
422 : : Keyword vector
423 : : The following code generates a vector of keywords, for the sole purpose
424 : : of documentation and user-help (accessible via the --helpctr and
425 : : --helpkw cmdline arguments. If entries for a keyword are not added to
426 : : this vector, help will not be output for it. The entries follow the
427 : : function signature of the tk::entry_t constructor (defined in
428 : : Base/Types.hpp).
429 : : */
430 : : // -----------------------------------------------------------------------
431 : 2666 : std::set< tk::entry_t > keywords;
432 : :
433 : : keywords.insert({"inciter",
434 : : "Start configuration block for inciter",
435 : : R"(This keyword is used to select inciter. Inciter, is a continuum-realm
436 : : shock hydrodynamics tool, solving a system of PDEs. The entire control
437 [ + - ][ + - ]: 1333 : file must be enclosed within the inciter block)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
438 : :
439 : : keywords.insert({"title", "Title", R"(The title may be specified in
440 [ + - ][ + - ]: 1333 : the input file. It is optional.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
441 : :
442 : : // -----------------------------------------------------------------------
443 : : // time stepping options
444 : : // -----------------------------------------------------------------------
445 : :
446 : : keywords.insert({"nstep", "Set number of time steps to take",
447 : : R"(This keyword is used to specify the number of time steps to take in a
448 : : simulation. The number of time steps are used in conjunction with the
449 : : maximmum time specified by keyword 'term': the simulation stops whichever
450 : : is reached first. Both 'nstep' and 'term' can be left unspecified, in
451 [ + - ][ + - ]: 1333 : which case their default values are used. See also 'term'.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
452 : :
453 : : keywords.insert({"term", "Set maximum physical time to simulate",
454 : : R"(This keyword is used to specify the termination time in a simulation.
455 : : The termination time and number of time steps, specified by 'nstep', are
456 : : used in conjunction to determine when to stop a simulation: whichever is
457 : : reached first. Both 'nstep' and 'term' can be left unspecified, in which
458 [ + - ][ + - ]: 1333 : case their default values are used. See also 'nstep'.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
459 : :
460 : : keywords.insert({"t0", "Set starting non-dimensional time",
461 : : R"(This keyword is used to specify the starting time in a simulation.)",
462 [ + - ][ + - ]: 1333 : "real"});
[ + - ][ + - ]
[ + - ][ + - ]
463 : :
464 : : keywords.insert({"dt", "Select constant time step size",
465 : : R"(This keyword is used to specify the time step size that used as a
466 : : constant during simulation. Setting 'cfl' and 'dt' are mutually
467 [ + - ][ + - ]: 1333 : exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
468 : :
469 : : keywords.insert({"cfl",
470 : : "Set the Courant-Friedrichs-Lewy (CFL) coefficient",
471 : : R"(This keyword is used to specify the CFL coefficient for
472 : : variable-time-step-size simulations. Setting 'cfl' and 'dt' are mutually
473 [ + - ][ + - ]: 1333 : exclusive. If both 'cfl' and 'dt' are set, 'dt' wins.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
474 : :
475 : : keywords.insert({"ttyi", "Set screen output interval",
476 : : R"(This keyword is used to specify the interval in time steps for screen
477 [ + - ][ + - ]: 1333 : output during a simulation.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
478 : :
479 : : keywords.insert({"imex_runge_kutta",
480 : : "Toggle use of IMplicit-EXplicit Runge-Kutta scheme",
481 : : R"(This keywords is used to turn IMEX integrator on/off for solid materials
482 : : in a multimat run. Plastic terms are integrated implicitly in time. This
483 : : flag will activate an Implicit-Explicit Runge-Kutta scheme to replace the
484 : : explicit one that is usually used. Scheme taken from Cavaglieri, D., &
485 : : Bewley, T. (2015). Low-storage implicit/explicit Runge–Kutta schemes for
486 : : the simulation of stiff high-dimensional ODE systems. Journal of
487 [ + - ][ + - ]: 1333 : Computational Physics, 286, 172-193.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ + - ]
488 : :
489 : : keywords.insert({"imex_maxiter",
490 : : "Set maximum number of iterations for non-linear solver with IMEX-RK scheme",
491 : : R"(This keywords is used to specify the maximum number of iterations that
492 : : the non-linear solver uses to obtain the implicit unknowns within the
493 [ + - ][ + - ]: 1333 : Implicit-Explicit Runge-Kutta scheme.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
494 : :
495 : : keywords.insert({"imex_reltol",
496 : : "Set relative tolerance for non-linear solver with IMEX-RK scheme",
497 : : R"(This keywords is used to specify the relative tolerance that
498 : : the non-linear solver uses to obtain the implicit unknowns within the
499 [ + - ][ + - ]: 1333 : Implicit-Explicit Runge-Kutta scheme.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
500 : :
501 : : keywords.insert({"imex_abstol",
502 : : "Set absolute tolerance for non-linear solver with IMEX-RK scheme",
503 : : R"(This keywords is used to specify the absolute tolerance that
504 : : the non-linear solver uses to obtain the implicit unknowns within the
505 [ + - ][ + - ]: 1333 : Implicit-Explicit Runge-Kutta scheme.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
506 : :
507 : : // -----------------------------------------------------------------------
508 : : // steady-state solver options
509 : : // -----------------------------------------------------------------------
510 : :
511 : : keywords.insert({"steady_state", "March to steady state",
512 : : R"(This keyword is used indicate that local time stepping should be used
513 [ + - ][ + - ]: 1333 : to march towards a stationary solution.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
514 : :
515 : : keywords.insert({"residual",
516 : : "Set the convergence criterion for the residual to reach",
517 : : R"(This keyword is used to specify a convergence criterion for the local
518 : : time stepping marching to steady state, below which the simulation is
519 [ + - ][ + - ]: 1333 : considered converged.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
520 : :
521 : : keywords.insert({"rescomp",
522 : : "Equation system component index for convergence",
523 : : R"(This keyword is used to specify a single integer that is used to denote
524 : : the equation component index in the complete system of equations
525 : : configured, to use for the convergence criterion for local
526 [ + - ][ + - ]: 1333 : time stepping marching towards steady state.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
527 : :
528 : : // -----------------------------------------------------------------------
529 : : // mesh partitioning and reordering/sorting choices
530 : : // -----------------------------------------------------------------------
531 : :
532 : : keywords.insert({"partitioning",
533 : : "Select mesh partitioning algorithm",
534 : : R"(This keyword is used to select a mesh partitioning algorithm. See
535 : : Control/Options/PartitioningAlgorithm.hpp for valid options.)",
536 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
537 : :
538 : : keywords.insert({"rcb",
539 : : "Select recursive coordinate bisection mesh partitioner",
540 : : R"(This keyword is used to select the recursive coordinate bisection (RCB)
541 : : mesh partitioner. RCB is a geometry-based partitioner used to distribute
542 : : an input mesh among processing elements. See
543 [ + - ][ + - ]: 1333 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
544 : :
545 : : keywords.insert({"rib",
546 : : "Select recursive inertial bisection mesh partitioner",
547 : : R"(This keyword is used to select the recursive inertial bisection (RIB)
548 : : mesh partitioner. RIB is a geometry-based partitioner used to distribute
549 : : an input mesh among processing elements. See
550 [ + - ][ + - ]: 1333 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
551 : :
552 : : keywords.insert({"hsfc",
553 : : "Select Hilbert Space Filling Curve (HSFC) mesh partitioner",
554 : : R"(This keyword is used to select the Hilbert Space Filling Curve (HSFC)
555 : : mesh partitioner. HSFC is a geometry-based partitioner used to distribute
556 : : an input mesh among processing elements. See
557 [ + - ][ + - ]: 1333 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
558 : :
559 : : keywords.insert({"phg",
560 : : "Select parallel hypergraph mesh partitioner",
561 : : R"(This keyword is used to select the parallel hypergraph (PHG)
562 : : mesh partitioner. PHG is a graph-based partitioner used to distribute an
563 : : input mesh among processing elements. See
564 [ + - ][ + - ]: 1333 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
565 : :
566 : : keywords.insert({"mj",
567 : : "Select multi-jagged (MJ) mesh partitioner",
568 : : R"(This keyword is used to select the multi-jagged (MJ) mesh partitioner.
569 : : MJ is a geometry-based partitioner used to distribute an input mesh among
570 : : processing elements. See
571 [ + - ][ + - ]: 1333 : Control/Options/PartitioningAlgorithm.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
572 : :
573 : : keywords.insert({"pelocal_reorder",
574 : : "PE-local reorder",
575 : : R"(This keyword is used in inciter as a keyword in the inciter...end block
576 : : as "pelocal_reorder true" (or false) to do (or not do) a global
577 : : distributed mesh reordering across all PEs that yields an approximately
578 : : continuous mesh node ID order as mesh partitions are assigned to PEs after
579 [ + - ][ + - ]: 1333 : mesh partitioning. This reordering is optional.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
580 : :
581 : : keywords.insert({"operator_reorder",
582 : : "Operator-access reorder",
583 : : R"(This keyword is used in inciter as a keyword in the inciter...end block
584 : : as "operator_reorder on" (or off) to do (or not do) a local mesh node
585 : : reordering based on the PDE operator access pattern. This reordering is
586 [ + - ][ + - ]: 1333 : optional.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
587 : :
588 : : // -----------------------------------------------------------------------
589 : : // discretization scheme choices
590 : : // -----------------------------------------------------------------------
591 : :
592 : : keywords.insert({"scheme", "Select discretization scheme",
593 : : R"(This keyword is used to select a spatial discretization scheme,
594 : : necessarily connected to the temporal discretization scheme. See
595 [ + - ][ + - ]: 1333 : Control/Inciter/Options/Scheme.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
596 : :
597 : : keywords.insert({"alecg",
598 : : "Select continuous Galerkin with ALE + Runge-Kutta",
599 : : R"(This keyword is used to select the continuous Galerkin finite element
600 : : scheme in the arbitrary Lagrangian-Eulerian (ALE) reference frame combined
601 : : with Runge-Kutta (RK) time stepping.
602 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
603 : :
604 : : keywords.insert({"oversetfe",
605 : : "Select continuous Galerkin finite element with overset meshes + "
606 : : "Runge-Kutta",
607 : : R"(This keyword is used to select the continuous Galerkin finite element
608 : : scheme with Runge-Kutta (RK) time stepping, combined with overset grids.
609 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
610 : :
611 : : keywords.insert({"dg",
612 : : "Select 1st-order discontinuous Galerkin discretization + Runge-Kutta",
613 : : R"(This keyword is used to select the first-order accurate discontinuous
614 : : Galerkin, DG(P0), spatial discretiztaion used in Inciter. As this is first
615 : : order accurate, it is intended for testing and debugging purposes only.
616 : : Selecting this spatial discretization also selects the Runge-Kutta scheme
617 : : for time discretization. See Control/Inciter/Options/Scheme.hpp for other
618 [ + - ][ + - ]: 1333 : valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
619 : :
620 : : keywords.insert({"p0p1",
621 : : "Select 2nd-order finite volume discretization + Runge-Kutta",
622 : : R"(This keyword is used to select the second-order accurate finite volume,
623 : : P0P1, spatial discretiztaion used in Inciter. This method uses a
624 : : least-squares procedure to reconstruct the second-order solution from the
625 : : first-order one. Selecting this spatial discretization also selects the
626 : : Runge-Kutta scheme for time discretization.
627 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Scheme.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
628 : :
629 : : keywords.insert({"dgp1",
630 : : "Select 2nd-order discontinuous Galerkin discretization + Runge-Kutta",
631 : : R"(This keyword is used to select the second-order accurate discontinuous
632 : : Galerkin, DG(P1), spatial discretiztaion used in Inciter. Selecting this
633 : : spatial discretization also selects the Runge-Kutta scheme for time
634 : : discretization. See Control/Inciter/Options/Scheme.hpp for other
635 [ + - ][ + - ]: 1333 : valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
636 : :
637 : : keywords.insert({"dgp2",
638 : : "Select 3nd-order discontinuous Galerkin discretization + Runge-Kutta",
639 : : R"(This keyword is used to select the third-order accurate discontinuous
640 : : Galerkin, DG(P2), spatial discretiztaion used in Inciter. Selecting this
641 : : spatial discretization also selects the Runge-Kutta scheme for time
642 : : discretization. See Control/Inciter/Options/Scheme.hpp for other
643 [ + - ][ + - ]: 1333 : valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
644 : :
645 : : keywords.insert({"pdg",
646 : : "Select p-adaptive discontinuous Galerkin discretization + Runge-Kutta",
647 : : R"(This keyword is used to select the polynomial adaptive discontinuous
648 : : Galerkin spatial discretizaion used in Inciter. Selecting this spatial
649 : : discretization also selects the Runge-Kutta scheme for time
650 : : discretization. See Control/Inciter/Options/Scheme.hpp for other valid
651 [ + - ][ + - ]: 1333 : options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
652 : :
653 : : keywords.insert({"fv",
654 : : "Select 2nd-order finite volume discretization + Runge-Kutta",
655 : : R"(This keyword is used to select the second-order accurate finite volume,
656 : : P0P1, spatial discretiztaion used in Inciter. This method uses a
657 : : least-squares procedure to reconstruct the second-order solution from the
658 : : first-order one. See Control/Inciter/Options/Scheme.hpp for other valid
659 [ + - ][ + - ]: 1333 : options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
660 : :
661 : : keywords.insert({"ndof", "Number of evolved solution DOFs",
662 [ + - ][ + - ]: 1333 : R"(The number of solution DOFs that are evolved.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
663 : :
664 : : keywords.insert({"rdof", "Total number of solution DOFs",
665 : : R"(The total number of solution DOFs, including the reconstructed and the
666 [ + - ][ + - ]: 1333 : evolved ones.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
667 : :
668 : : // -----------------------------------------------------------------------
669 : : // limiter options
670 : : // -----------------------------------------------------------------------
671 : :
672 : : keywords.insert({"limiter", "Select limiter function",
673 : : R"(This keyword is used to select a limiter function, used for
674 : : discontinuous Galerkin (DG) spatial discretization used in inciter. See
675 [ + - ][ + - ]: 1333 : Control/Inciter/Options/Limiter.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
676 : :
677 : : keywords.insert({"nolimiter", "No limiter used",
678 : : R"(This keyword is used for discontinuous Galerkin (DG) spatial
679 : : discretization without any limiter in inciter. See
680 [ + - ][ + - ]: 1333 : Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
681 : :
682 : : keywords.insert({"wenop1",
683 : : "Select the Weighted Essentially Non-Oscillatory (WENO) limiter for DGP1",
684 : : R"(This keyword is used to select the Weighted Essentially Non-Oscillatory
685 : : limiter used for discontinuous Galerkin (DG) P1 spatial discretization
686 : : used in inciter. See Control/Inciter/Options/Limiter.hpp for other valid
687 [ + - ][ + - ]: 1333 : options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
688 : :
689 : : keywords.insert({"cweight",
690 : : "Set value for central linear weight used by WENO, cweight",
691 : : R"(This keyword is used to set the central linear weight used for the
692 : : central stencil in the Weighted Essentially Non-Oscillatory (WENO) limiter
693 [ + - ][ + - ]: 1333 : for discontinuous Galerkin (DG) methods.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
694 : :
695 : : keywords.insert({"superbeep1",
696 : : "Select the Superbee limiter for DGP1",
697 : : R"(This keyword is used to select the Superbee limiter used for
698 : : discontinuous Galerkin (DG) P1 spatial discretization used in inciter.
699 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
700 : :
701 : : keywords.insert({"shock_detector_coeff",
702 : : "Configure the coefficient used in shock indicator",
703 : : R"(This keyword can be used to configure the coefficient used in the
704 [ + - ][ + - ]: 1333 : threshold calculation for the shock indicator.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
705 : :
706 : : keywords.insert({"vertexbasedp1",
707 : : "Select the vertex-based limiter for DGP1",
708 : : R"(This keyword is used to select the vertex-based limiter used for
709 : : discontinuous Galerkin (DG) P1 spatial discretization used in inciter.
710 : : Ref. Kuzmin, D. (2010). A vertex-based hierarchical slope limiter for
711 : : p-adaptive discontinuous Galerkin methods. Journal of computational and
712 : : applied mathematics, 233(12), 3077-3085.
713 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Limiter.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
714 : :
715 : : keywords.insert({"accuracy_test", "Toggle accuracy test setup",
716 : : R"(This keyword is used to specify if the current setup is for an
717 : : order-of-accuracy testing, used for discontinuous Galerkin (DG) spatial
718 : : discretization in inciter. This deactivates certain robustness corrections
719 : : which might impact order-of-accuracy. Only intended for simple test
720 [ + - ][ + - ]: 1333 : problems and not for real problems.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
721 : :
722 : : keywords.insert({"limsol_projection",
723 : : "Toggle limited solution projection",
724 : : R"(This keyword is used to specify limited solution projection.
725 : : This is used for discontinuous Galerkin (DG) spatial discretization in
726 : : inciter, for multi-material hydrodynamics. This uses a projection to
727 : : obtain bulk momentum and material energies from the limited primitive
728 : : quantities. This step is essential to obtain closure-law obeying limited
729 : : quantities. See Pandare et al. (2023). On the Design of Stable,
730 : : Consistent, and Conservative High-Order Methods for Multi-Material
731 [ + - ][ + - ]: 1333 : Hydrodynamics. J Comp Phys (490).)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
732 : :
733 : : // -----------------------------------------------------------------------
734 : : // flux options
735 : : // -----------------------------------------------------------------------
736 : :
737 : : keywords.insert({"flux", "Select flux function",
738 : : R"(This keyword is used to select a flux function, used for
739 : : discontinuous Galerkin (DG) spatial discretization used in inciter. See
740 [ + - ][ + - ]: 1333 : Control/Inciter/Options/Flux.hpp for valid options.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
741 : :
742 : : keywords.insert({"laxfriedrichs",
743 : : "Select Lax-Friedrichs flux function",
744 : : R"(This keyword is used to select the Lax-Friedrichs flux function used
745 : : for discontinuous Galerkin (DG) spatial discretization used in inciter.
746 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Flux.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
747 : :
748 : : keywords.insert({"hllc",
749 : : "Select the Harten-Lax-van Leer-Contact (HLLC) flux function",
750 : : R"(This keyword is used to select the Harten-Lax-van Leer-Contact flux
751 : : function used for discontinuous Galerkin (DG) spatial discretization
752 : : used in inciter. See Control/Inciter/Options/Flux.hpp for other valid
753 [ + - ][ + - ]: 1333 : options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
754 : :
755 : : keywords.insert({"upwind", "Select the upwind flux function",
756 : : R"(This keyword is used to select the upwind flux
757 : : function used for discontinuous Galerkin (DG) spatial discretization
758 : : used in inciter. It is only usable for scalar transport.
759 [ + - ][ + - ]: 1333 : See Control/Inciter/Options/Flux.hpp for other valid options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
760 : :
761 : : keywords.insert({"ausm",
762 : : "Select the Advection Upstream Splitting Method (AUSM) flux function",
763 : : R"(This keyword is used to select the AUSM flux
764 : : function used for discontinuous Galerkin (DG) spatial discretization
765 : : used in inciter. It is only set up for for multi-material hydro, and
766 [ + - ][ + - ]: 1333 : not selectable for anything else.)"});
[ + - ][ + - ]
[ + - ][ + - ]
767 : :
768 : : keywords.insert({"lowspeed_kp",
769 : : "Select the low-speed coefficient K_p in the AUSM+up flux function",
770 : : R"(This keyword is used to select the low-speed coefficient K_p in the
771 : : AUSM+up flux function used for the DG or FV spatial discretization for
772 : : multi-material hydro, and not used for anything else. The default
773 : : value is 0, and recommended value for low speed flows (Mach < 0.1) is
774 [ + - ][ + - ]: 1333 : 1.)"});
[ + - ][ + - ]
[ + - ][ + - ]
775 : :
776 : : keywords.insert({"hll",
777 : : "Select the Harten-Lax-vanLeer (HLL) flux function",
778 : : R"(This keyword is used to select the HLL flux
779 : : function used for discontinuous Galerkin (DG) spatial discretization
780 : : used in inciter. It is only set up for for multi-material hydro, and
781 [ + - ][ + - ]: 1333 : not selectable for anything else.)"});
[ + - ][ + - ]
[ + - ][ + - ]
782 : :
783 : : // -----------------------------------------------------------------------
784 : : // PDE keywords
785 : : // -----------------------------------------------------------------------
786 : :
787 : : keywords.insert({"problem",
788 : : "Specify problem configuration for partial differential equation solver",
789 : : R"(This keyword is used to specify the problem configuration for the
790 [ + - ][ + - ]: 1333 : partial differential equation solver.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
791 : :
792 : : keywords.insert({"transport",
793 : : "Start configuration block for an transport equation",
794 : : R"(This keyword is used to introduce a transport block, used to
795 : : specify the configuration for a transport equation type.)",
796 [ + - ][ + - ]: 1333 : "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
797 : :
798 : : keywords.insert({"ncomp",
799 : : "Set number of scalar components for a system of transport equations",
800 : : R"(This keyword is used to specify the number of scalar
801 [ + - ][ + - ]: 1333 : components of transport (linear advection) equations.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
802 : :
803 : : keywords.insert({"compflow",
804 : : "Start configuration block for the compressible flow equations",
805 : : R"(This keyword is used to introduce the compflow block, used to
806 : : specify the configuration for a system of partial differential equations,
807 [ + - ][ + - ]: 1333 : governing single material compressible fluid flow.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
808 : :
809 : : keywords.insert({"multimat",
810 : : "Start configuration block for the compressible multi-material equations",
811 : : R"(This keyword is used to introduce the multimat block,
812 : : used to specify the configuration for a system of partial differential
813 : : equations, governing compressible multi-material hydrodynamics assuming
814 [ + - ][ + - ]: 1333 : velocity equilibrium (single velocity).)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
815 : :
816 : : keywords.insert({"multispecies",
817 : : "Start configuration block for the compressible multi-species equations",
818 : : R"(This keyword is used to introduce the multispecies block,
819 : : used to specify the configuration for a system of partial differential
820 : : equations, governing compressible multi-species fluid dynamics.)",
821 [ + - ][ + - ]: 1333 : "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
822 : :
823 : : keywords.insert({"nmat",
824 : : "Set number of materials for the multi-material system",
825 : : R"(This keyword is used to specify the number of materials for
826 [ + - ][ + - ]: 1333 : multi-material flow, see also the keyword 'multimat'.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
827 : :
828 : : keywords.insert({"nspec",
829 : : "Set number of species for the multi-species system",
830 : : R"(This keyword is used to specify the number of species for
831 [ + - ][ + - ]: 1333 : multi-species flow, see also the keyword 'multispecies'.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
832 : :
833 : : keywords.insert({"prelax",
834 : : "Toggle multi-material finite pressure relaxation",
835 : : R"(This keyword is used to turn finite pressure relaxation between
836 : : multiple materials on/off. It is used only for the multi-material solver,
837 [ + - ][ + - ]: 1333 : and has no effect when used for the other PDE types.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ + - ]
838 : :
839 : : keywords.insert({"prelax_timescale",
840 : : "Time-scale for multi-material finite pressure relaxation",
841 : : R"(This keyword is used to specify the time-scale at which finite pressure
842 : : relaxation between multiple materials occurs. The default value of 0.25
843 : : corresponds to a relaxation time that is 4 times the time required for a
844 : : sound wave to pass through a computational element. It is used only for
845 [ + - ][ + - ]: 1333 : multimat, and has no effect for the other PDE types.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
846 : :
847 : : keywords.insert({"intsharp",
848 : : "Toggle multi-material interface sharpening",
849 : : R"(This keyword is used to turn interface sharpening on/off. It uses the
850 : : multi-material THINC interface reconstruction.
851 : : Ref. Pandare A. K., Waltz J., & Bakosi J. (2021) Multi-Material
852 : : Hydrodynamics with Algebraic Sharp Interface Capturing. Computers &
853 : : Fluids, doi: https://doi.org/10.1016/j.compfluid.2020.104804. It is used
854 : : for the multi-material and the transport solver, and has no effect when
855 [ + - ][ + - ]: 1333 : used for the other PDE types.)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ + - ]
856 : :
857 : : keywords.insert({"intsharp_param",
858 : : "Parameter for multi-material interface sharpening",
859 : : R"(This keyword is used to specify the parameter for the interface
860 : : sharpening. This parameter affects how many cells the material interfaces
861 : : span, after the use of sharpening. It is used for multimat and transport,
862 [ + - ][ + - ]: 1333 : and has no effect for the other PDE types.)", "real" });
[ + - ][ + - ]
[ + - ][ + - ]
863 : :
864 : : keywords.insert({"rho0constraint",
865 : : "Toggle the density constraint correction",
866 : : R"(This keyword is used to toggle the density constraint in solid
867 : : dynamics on/off. It is used only for the multi-material solver in the
868 [ + - ][ + - ]: 1333 : presence of solids. The default is 1 (on).)", "uint 0/1"});
[ + - ][ + - ]
[ + - ][ + - ]
869 : :
870 : : keywords.insert({"dt_sos_massavg",
871 : : "Toggle method for calculating speed of sound used for time step in a cell",
872 : : R"(This keyword is used to specify the method to calculate the speed of
873 : : sound in a cell used for the time step. If set to 1, the speed of sound
874 : : will be calculated using the mass average, rather than the maximum value
875 : : across materials. It is used for multimat, and has no effect for the
876 [ + - ][ + - ]: 1333 : other PDE types.)", "uint 0/1" });
[ + - ][ + - ]
[ + - ][ + - ]
877 : :
878 : : // Dependent variable name
879 : : keywords.insert({"depvar",
880 : : "Select dependent variable name for PDE.",
881 [ + - ][ + - ]: 1333 : R"(Select dependent variable name for PDE.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
882 : :
883 : : // -----------------------------------------------------------------------
884 : : // physics choices
885 : : // -----------------------------------------------------------------------
886 : :
887 : : keywords.insert({"physics",
888 : : "Specify the physics configuration for a system of PDEs",
889 : : R"(This keyword is used to select the physics configuration for a
890 : : particular PDE system. Valid options depend on the system of PDEs in
891 [ + - ][ + - ]: 1333 : which the keyword is used.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
892 : :
893 : : keywords.insert({"advection",
894 : : "Specify the advection physics",
895 : : R"(This keyword is used to select the advection physics for the transport
896 [ + - ][ + - ]: 1333 : PDE system. Only usable for 'transport'.)"});
[ + - ][ + - ]
[ + - ][ + - ]
897 : :
898 : : keywords.insert({"advdiff",
899 : : "Specify the advection + diffusion physics",
900 : : R"(This keyword is used to select the advection + diffusion physics
901 [ + - ][ + - ]: 1333 : for transport PDEs. Only usable for 'transport'.)"});
[ + - ][ + - ]
[ + - ][ + - ]
902 : :
903 : : keywords.insert({"euler",
904 : : "Specify the Euler (inviscid) compressible flow physics",
905 : : R"(This keyword is used to select the Euler (inviscid) compressible
906 [ + - ][ + - ]: 1333 : flow physics configuration. Usable for 'compflow' and 'multimat')"});
[ + - ][ + - ]
[ + - ][ + - ]
907 : :
908 : : keywords.insert({"energy_pill",
909 : : "Specify the energy pill physics",
910 : : R"(This keyword is used to select an energy pill initialization as physics
911 : : configuration for multiple material compressible flow. Parameters for the
912 : : linearly traveling front are required to be specified when energy_pill is
913 : : selected. See 'linear' for more details. Currently setup only for
914 [ + - ][ + - ]: 1333 : 'multimat')"});
[ + - ][ + - ]
[ + - ][ + - ]
915 : :
916 : : // -----------------------------------------------------------------------
917 : : // material/eos object
918 : : // -----------------------------------------------------------------------
919 : :
920 : : keywords.insert({"material",
921 : : "Start configuration block for material (eos) properties",
922 : : R"(This keyword is used to introduce a material block, used to
923 [ + - ][ + - ]: 1333 : specify material properties.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
924 : :
925 : : keywords.insert({"id", "ID",
926 : : R"(This keyword is used to specify an ID, a positive integer. Usage is
927 : : context specific, i.e. what block it is specified in. E.g. Inside the
928 : : material block, it is used to specify a block consisting of IDs of
929 [ + - ][ + - ]: 1333 : materials of that EOS type)", "vector of uints"});
[ + - ][ + - ]
[ + - ][ + - ]
930 : :
931 : : keywords.insert({"eos", "Select equation of state (type)",
932 : : R"(This keyword is used to select an equation of state for a material.)",
933 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
934 : :
935 : : keywords.insert({"gamma", "ratio of specific heats",
936 : : R"(This keyword is used to specify the material property, ratio of
937 [ + - ][ + - ]: 1333 : specific heats.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
938 : :
939 : : keywords.insert({"pstiff", "EoS stiffness parameter",
940 : : R"(This keyword is used to specify the material property, stiffness
941 [ + - ][ + - ]: 1333 : parameter in the stiffened gas equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
942 : :
943 : : keywords.insert({"w_gru", "Grueneisen coefficient",
944 : : R"(This keyword is used to specify the material property, Gruneisen
945 : : coefficient for the Jones-Wilkins-Lee equation of state.)",
946 [ + - ][ + - ]: 1333 : "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
947 : :
948 : : keywords.insert({"A_jwl", "JWL EoS A parameter",
949 : : R"(This keyword is used to specify the material property A (units: Pa)
950 [ + - ][ + - ]: 1333 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
951 : :
952 : : keywords.insert({"B_jwl", "JWL EoS B parameter",
953 : : R"(This keyword is used to specify the material property B (units: Pa)
954 [ + - ][ + - ]: 1333 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
955 : :
956 : : keywords.insert({"C_jwl", "JWL EoS C parameter",
957 : : R"(This keyword is used to specify the material property C (units: Pa)
958 [ + - ][ + - ]: 1333 : for the Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
959 : :
960 : : keywords.insert({"R1_jwl", "JWL EoS R1 parameter",
961 : : R"(This keyword is used to specify the material property R1 for the
962 [ + - ][ + - ]: 1333 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
963 : :
964 : : keywords.insert({"R2_jwl", "JWL EoS R2 parameter",
965 : : R"(This keyword is used to specify the material property R2 for the
966 [ + - ][ + - ]: 1333 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
967 : :
968 : : keywords.insert({"rho0_jwl", "JWL EoS rho0 parameter",
969 : : R"(This keyword is used to specify the material property rho0, which is
970 : : the density of initial state (units: kg/m3) for the Jones-Wilkins-Lee
971 [ + - ][ + - ]: 1333 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
972 : :
973 : : keywords.insert({"de_jwl", "JWL EoS de parameter",
974 : : R"(This keyword is used to specify the material property de, which is the
975 : : heat of detonation for products; and for reactants, it is chosen such that
976 : : the ambient internal energy (e0) is 0 (units: J/kg). Used for the
977 [ + - ][ + - ]: 1333 : Jones-Wilkins-Lee equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
978 : :
979 : : keywords.insert({"rhor_jwl", "JWL EoS rhor parameter",
980 : : R"(This keyword is used to specify the material property rhor, which is
981 : : the density of reference state (units: kg/m3) for the Jones-Wilkins-Lee
982 [ + - ][ + - ]: 1333 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
983 : :
984 : : keywords.insert({"Tr_jwl", "JWL EoS Tr parameter",
985 : : R"(This keyword is used to specify the material property Tr, which is the
986 : : temperature of reference state (units: K) for the Jones-Wilkins-Lee
987 [ + - ][ + - ]: 1333 : equation of state.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
988 : :
989 : : keywords.insert({"Pr_jwl", "JWL EoS er parameter",
990 : : R"(This keyword is used to specify the material property Pr, which is the
991 : : pressure at the reference state (units: Pa) for the Jones-Wilkins-Lee
992 : : equation of state. It is used to calculate the reference temperature for
993 [ + - ][ + - ]: 1333 : the EoS.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
994 : :
995 : : keywords.insert({"mu", "shear modulus/dynamic viscosity",
996 : : R"(This keyword is used to specify the material property, shear modulus
997 [ + - ][ + - ]: 1333 : for solids, or dynamic viscosity for fluids.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
998 : :
999 : : keywords.insert({"yield_stress", "Yield stress of solid material",
1000 : : R"(This keyword is used to specify the material property yield stress,
1001 : : which indicates the stress (units: Pa) after which the material begins
1002 [ + - ][ + - ]: 1333 : plastic flow.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1003 : :
1004 : : keywords.insert({"cv", "specific heat at constant volume",
1005 : : R"(This keyword is used to specify the material property, specific heat at
1006 [ + - ][ + - ]: 1333 : constant volume.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1007 : :
1008 : : keywords.insert({"k", "heat conductivity",
1009 : : R"(This keyword is used to specify the material property, heat
1010 [ + - ][ + - ]: 1333 : conductivity.)", "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1011 : :
1012 : : keywords.insert({"stiffenedgas",
1013 : : "Select the stiffened gas equation of state",
1014 [ + - ][ + - ]: 1333 : R"(This keyword is used to select the stiffened gas equation of state.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1015 : :
1016 : : keywords.insert({"jwl", "Select the JWL equation of state",
1017 : : R"(This keyword is used to select the Jones, Wilkins, Lee equation of
1018 [ + - ][ + - ]: 1333 : state.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1019 : :
1020 : : keywords.insert({"smallshearsolid",
1021 : : "Select the SMALLSHEARSOLID equation of state",
1022 : : R"(This keyword is used to select the small shear strain equation of state
1023 : : for solids. This EOS uses a small-shear approximation for the elastic
1024 : : contribution, and a stiffened gas EOS for the hydrodynamic contribution of
1025 : : the internal energy See Plohr, J. N., & Plohr, B. J. (2005). Linearized
1026 : : analysis of Richtmyer–Meshkov flow for elastic materials. Journal of Fluid
1027 [ + - ][ + - ]: 1333 : Mechanics, 537, 55-89 for further details.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1028 : :
1029 : : keywords.insert({"godunovromenski_aluminum",
1030 : : "Select the GODUNOVROMENSKIALUMINUM equation of state",
1031 : : R"(This keyword is used to select the Godunov-Romenski equation of
1032 : : state for solids and a hydro EoS for aluminum. These function were
1033 : : taken from Barton, Philip T. "An interface-capturing Godunov method
1034 : : for the simulation of compressible solid-fluid problems." Journal
1035 [ + - ][ + - ]: 1333 : of Computational Physics 390 (2019): 25-50.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1036 : :
1037 : : keywords.insert({"matidxmap",
1038 : : "AUTO-GENERATED Material index map for EOS",
1039 : : R"(The following AUTO-GENERATED data structure is used to index into the
1040 : : correct material vector entry. This is done using the following three maps:
1041 : : 1. eosidx: This vector provides the eos-index (value) in the
1042 : : vector<tag::material> for the given user-spec material id (index).
1043 : : 2. matidx: This vector provides the material-index (value) inside the
1044 : : vector<tag::material>[eosidx] block for the given user-specified
1045 : : material id (index).
1046 : : 3. solidx: This vector provides the solid-index (value) assigned to
1047 [ + - ][ + - ]: 1333 : the given user-specified material id (index). It is 0 for fluids.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1048 : :
1049 : : // -----------------------------------------------------------------------
1050 : : // output object
1051 : : // -----------------------------------------------------------------------
1052 : :
1053 : : keywords.insert({"field_output",
1054 : : "Start of field_output input block",
1055 : : R"(This keyword is used to start a block in the input file containing the
1056 [ + - ][ + - ]: 1333 : list and settings of requested field output.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1057 : :
1058 : : keywords.insert({"interval",
1059 : : "Set interval (in units of iteration count)",
1060 : : R"(This keyword is used to specify an interval in units of iteration count
1061 : : (i.e., number of time steps). This must be used within a relevant
1062 [ + - ][ + - ]: 1333 : block.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1063 : :
1064 : : keywords.insert({"time_interval",
1065 : : "Set interval (in units of physics time)",
1066 : : R"(This keyword is used to specify an interval in units of physics time.
1067 [ + - ][ + - ]: 1333 : This must be used within a relevant block.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1068 : :
1069 : : keywords.insert({"time_range",
1070 : : "Configure physics time range for output (in units of physics time)",
1071 : : R"(This keyword is used to configure field-, or history-output, specifying
1072 : : a start time, a stop time, and an output frequency in physics time units.
1073 : : Example: 'time_range = {0.2, 0.3, 0.001}', which specifies that from t=0.2 to
1074 : : t=0.3 output should happen at physics time units of dt=0.001. This must be
1075 [ + - ][ + - ]: 1333 : used within a relevant block.)", "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1076 : :
1077 : : keywords.insert({"refined", "Toggle refined field output on/off",
1078 : : R"(This keyword can be used to turn on/off refined field output, which
1079 : : refines the mesh and evaluates the solution on the refined mesh for saving
1080 [ + - ][ + - ]: 1333 : the solution.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
1081 : :
1082 : : keywords.insert({"filetype", "Select output file type",
1083 : : R"(This keyword is used to specify the output file type of
1084 [ + - ][ + - ]: 1333 : mesh-based field output in a field_output block.)", "string" });
[ + - ][ + - ]
[ + - ][ + - ]
1085 : :
1086 : : keywords.insert({"elemvar",
1087 : : "Specify list of elem-centered variables for output",
1088 : : R"(This keyword is used to specify elem-centered variables for output to
1089 [ + - ][ + - ]: 1333 : file. It is used in field_output blocks.)", "vector of string"});
[ + - ][ + - ]
[ + - ][ + - ]
1090 : :
1091 : : keywords.insert({"nodevar",
1092 : : "Specify list of node-centered variables for output",
1093 : : R"(This keyword is used to specify node-centered variables for output to
1094 [ + - ][ + - ]: 1333 : file. It is used in field_output blocks.)", "vector of string"});
[ + - ][ + - ]
[ + - ][ + - ]
1095 : :
1096 : : keywords.insert({"sideset",
1097 : : "Specify list of side sets",
1098 : : R"(This keyword is used to specify side sets. Usage is context specific,
1099 : : i.e. depends on what block it is specified in. Eg. in the field_output
1100 : : block it specifies the sidesets on which field output is desired.)",
1101 [ + - ][ + - ]: 1333 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ + - ]
1102 : :
1103 : : keywords.insert({"diagnostics",
1104 : : "Specify the diagnostics block",
1105 : : R"(This keyword is used to introduce the dagnostics block, used to
1106 [ + - ][ + - ]: 1333 : configure diagnostics output.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1107 : :
1108 : : keywords.insert({"interval",
1109 : : "Set interval (in units of iteration count)",
1110 : : R"(This keyword is used to specify an interval in units of iteration count
1111 : : (i.e., number of time steps). Usage is context specific, and this must
1112 [ + - ][ + - ]: 1333 : be used within a relevant block.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1113 : :
1114 : : keywords.insert({"error", "Select an error type",
1115 : : R"(This keyword is used to select the error type. Used either in the
1116 : : diagnostics block to specify error norm, or in the AMR block to specify
1117 [ + - ][ + - ]: 1333 : the error for solution-adaptive mesh refinement.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1118 : :
1119 : : keywords.insert({"format",
1120 : : "Specify the ASCII floating-point output format",
1121 : : R"(This keyword is used to select the
1122 : : floating-point output format for ASCII floating-point number output.
1123 : : Valid options are 'default', 'fixed', and 'scientific'. For more info on
1124 : : these various formats, see
1125 [ + - ][ + - ]: 1333 : http://en.cppreference.com/w/cpp/io/manip/fixed.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1126 : :
1127 : : keywords.insert({"precision",
1128 : : "Precision in digits for ASCII floating-point output",
1129 : : R"(This keyword is used to select
1130 : : the precision in digits for ASCII floating-point real number output.
1131 : : Example: "precision=10", which selects ten digits for floating-point
1132 : : output, e.g., 3.141592654. The number of digits must be larger than zero
1133 : : and lower than the maximum representable digits for the given
1134 : : floating-point type. For more info on setting the precision in C++, see
1135 : : http://en.cppreference.com/w/cpp/io/manip/setprecision, and
1136 [ + - ][ + - ]: 1333 : http://en.cppreference.com/w/cpp/types/numeric_limits/digits10)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1137 : :
1138 : : keywords.insert({"history_output",
1139 : : "Start of history_output input block",
1140 : : R"(This keyword is used to start a block in the input file containing the
1141 [ + - ][ + - ]: 1333 : descriptions and settings of requested history output.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1142 : :
1143 : : keywords.insert({"point",
1144 : : "Start configuration block for history point, or a single point in IC blocks",
1145 : : R"(This keyword is used to either introduce a vector block used to
1146 : : specify probes for history output, or in the IC/BC block to specify
1147 : : a single point. When used in history output, it takes sub-entries of
1148 : : 'id' and 'coord'. When used in IC/BC, directly takes three reals as
1149 [ + - ][ + - ]: 1333 : coordinates.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1150 : :
1151 : : keywords.insert({"coord", "Specify point coordinates",
1152 : : R"(This keyword is used to specify coordinates of the history-point.)",
1153 [ + - ][ + - ]: 1333 : "3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1154 : :
1155 : : keywords.insert({"exodusii", "Select ExodusII output",
1156 : : R"(This keyword is used to select the
1157 : : ExodusII output file type readable by, e.g., ParaView of either a requested
1158 : : probability density function (PDF) within a pdfs ... end block or for
1159 : : mesh-based field output in a field_output ... end block. Example:
1160 : : "filetype exodusii", which selects ExodusII file output. For more info on
1161 [ + - ][ + - ]: 1333 : ExodusII, see http://sourceforge.net/projects/exodusii.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1162 : :
1163 : : keywords.insert({"density", "Request/specify density",
1164 : : R"(This keyword is used to request/specify the density. Usage is
1165 : : context specific. When specifed as 'elemvar' or 'nodevar' inside
1166 : : field_output, requests density as an output quantity. Otherwise,
1167 [ + - ][ + - ]: 1333 : specifies density at IC/BC.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1168 : :
1169 : : keywords.insert({"x-momentum",
1170 : : "Request x-momentum",
1171 : : R"(This keyword is used to request the fluid x-momentum as an output
1172 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1173 : :
1174 : : keywords.insert({"y-momentum",
1175 : : "Request y-momentum",
1176 : : R"(This keyword is used to request the fluid y-momentum as an output
1177 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1178 : :
1179 : : keywords.insert({"z-momentum",
1180 : : "Request z-momentum",
1181 : : R"(This keyword is used to request the fluid z-momentum as an output
1182 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1183 : :
1184 : : keywords.insert({
1185 : : "specific_total_energy", "Request specific total energy",
1186 : : R"(This keyword is used to request the specific total energy as an output
1187 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1188 : :
1189 : : keywords.insert({
1190 : : "volumetric_total_energy", "Request total volumetric energy",
1191 : : R"(This keyword is used to request the volumetric total energy as an output
1192 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1193 : :
1194 : : keywords.insert({"x-velocity",
1195 : : "Request x-velocity",
1196 : : R"(This keyword is used to request the fluid x-velocity as an output
1197 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1198 : :
1199 : : keywords.insert({"y-velocity",
1200 : : "Request y-velocity",
1201 : : R"(This keyword is used to request the fluid y-velocity as an output
1202 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1203 : :
1204 : : keywords.insert({"z-velocity",
1205 : : "Request z-velocity",
1206 : : R"(This keyword is used to request the fluid z-velocity as an output
1207 [ + - ][ + - ]: 1333 : variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1208 : :
1209 : : keywords.insert({"pressure", "Request/specify pressure",
1210 : : R"(This keyword is used to request/specify the pressure. Usage is
1211 : : context specific. When specifed as 'elemvar' or 'nodevar' inside
1212 : : field_output, requests pressure as an output quantity. Otherwise,
1213 [ + - ][ + - ]: 1333 : specifies pressure at IC/BC.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1214 : :
1215 : : keywords.insert({"material_indicator",
1216 : : "Request material_indicator",
1217 : : R"(This keyword is used to request the material indicator function as an
1218 [ + - ][ + - ]: 1333 : output variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1219 : :
1220 : : keywords.insert({"analytic",
1221 : : "Request analytic solution",
1222 : : R"(This keyword is used to request the analytic solution (if exist) as an
1223 [ + - ][ + - ]: 1333 : output variable.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1224 : :
1225 : : keywords.insert({"l2", "Select the L2 norm",
1226 [ + - ][ + - ]: 1333 : R"(This keyword is used to enable computing the L2 norm.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1227 : :
1228 : : keywords.insert({"linf", "Select the L_{infinity} norm",
1229 [ + - ][ + - ]: 1333 : R"(This keyword is used to enable computing the L-infinity norm.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1230 : :
1231 : : keywords.insert({"default",
1232 : : "Select the default ASCII floating-point output",
1233 : : R"(This keyword is used to select the
1234 : : 'default' floating-point output format for ASCII floating-point real
1235 : : number output. For more info on these various formats, see
1236 [ + - ][ + - ]: 1333 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1237 : :
1238 : : keywords.insert({"fixed",
1239 : : "Select the fixed ASCII floating-point output",
1240 : : R"(This keyword is used to select the
1241 : : 'fixed' floating-point output format for ASCII floating-point real
1242 : : number output. For more info on these various formats, see
1243 [ + - ][ + - ]: 1333 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1244 : :
1245 : : keywords.insert({"scientific",
1246 : : "Select the scientific ASCII floating-point output",
1247 : : R"(This keyword is used to select the
1248 : : 'scientific' floating-point output format for ASCII floating-point real
1249 : : number output. For more info on these various formats, see
1250 [ + - ][ + - ]: 1333 : http://en.cppreference.com/w/cpp/io/manip/fixed.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1251 : :
1252 : : // -----------------------------------------------------------------------
1253 : : // ALE options
1254 : : // -----------------------------------------------------------------------
1255 : :
1256 : : keywords.insert({"ale", "Start block configuring ALE",
1257 : : R"(This keyword is used to introduce the ale block, used to
1258 : : configure arbitrary Lagrangian-Eulerian (ALE) mesh movement.)",
1259 [ + - ][ + - ]: 1333 : "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1260 : :
1261 : : keywords.insert({"smoother", "Select mesh velocity smoother",
1262 : : R"(This keyword is used to select a mesh velocity smoother option, used
1263 : : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. Valid options are
1264 [ + - ][ + - ]: 1333 : 'laplace', 'helmholtz', and 'none')", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1265 : :
1266 : : keywords.insert({"mesh_velocity", "Select mesh velocity",
1267 : : R"(This keyword is used to select a mesh velocity option, used for
1268 : : Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. Valid options are
1269 [ + - ][ + - ]: 1333 : 'sine', 'fluid', and 'user_defined".)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1270 : :
1271 : : keywords.insert({"mesh_motion",
1272 : : "List of dimension indices that are allowed to move in ALE calculations",
1273 : : R"(This keyword is used to specify a list of integers (0, 1, or 2) whose
1274 : : coordinate directions corresponding to x, y, or z are allowed to move with
1275 : : the mesh velocity in ALE calculations. Useful for 1D/2D problems.)",
1276 [ + - ][ + - ]: 1333 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ + - ]
1277 : :
1278 : : keywords.insert({"meshforce", "Set ALE mesh force model parameter(s)",
1279 : : R"(This keyword is used to specify a vector of real numbers used to
1280 : : parameterize a mesh force model for ALE. The length of the vector must
1281 [ + - ][ + - ]: 1333 : exactly be 4.)", "vector of 4 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1282 : :
1283 : : keywords.insert({"dvcfl",
1284 : : "Set the volume-change Courant-Friedrichs-Lewy (CFL) coefficient",
1285 : : R"(This keyword is used to specify the volume-change (dV/dt) CFL coefficient
1286 : : for variable-time-step-size simulations due to volume change in time in
1287 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. Setting 'dvcfl' only has
1288 : : effect in ALE calculations and used together with 'cfl'. See also J. Waltz,
1289 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1290 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1291 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1292 [ + - ][ + - ]: 1333 : 2014.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1293 : :
1294 : : keywords.insert({"vortmult",
1295 : : "Configure vorticity multiplier for ALE mesh velocity",
1296 : : R"(This keyword is used to configure the multiplier for the vorticity term
1297 : : in the mesh velocity smoother (mesh_velocity=fluid) or for the potential
1298 : : gradient for the Helmholtz mesh velocity (mesh_velocity=helmholtz) for ALE
1299 : : mesh motion. For 'fluid' this is coefficient c2 in Eq.(36) of Waltz,
1300 : : Morgan, Canfield, Charest, Risinger, Wohlbier, A three-dimensional finite
1301 : : element arbitrary Lagrangian–Eulerian method for shock hydrodynamics on
1302 : : unstructured grids, Computers & Fluids, 2014, and for 'helmholtz', this
1303 : : is coefficient a1 in Eq.(23) of Bakosi, Waltz, Morgan, Improved ALE mesh
1304 : : velocities for complex flows, International Journal for Numerical Methods
1305 [ + - ][ + - ]: 1333 : in Fluids, 2017. )", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1306 : :
1307 : : keywords.insert({"maxit",
1308 : : "Set the max number of iterations for the ALE mesh velocity linear solve",
1309 : : R"(This keyword is used to specify the maximum number of linear solver
1310 : : iterations taken to converge the mesh velocity linear solve in
1311 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz,
1312 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1313 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1314 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1315 [ + - ][ + - ]: 1333 : 2014.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1316 : :
1317 : : keywords.insert({"tolerance",
1318 : : "Set the tolerance for the ALE mesh velocity linear solve",
1319 : : R"(This keyword is used to specify the tolerance to converge the mesh
1320 : : velocity linear solve for in
1321 : : arbitrary-Lagrangian-Eulerian (ALE) calculations. See also J. Waltz,
1322 : : N.R. Morgan, T.R. Canfield, M.R.J. Charest, L.D. Risinger, J.G. Wohlbier, A
1323 : : three-dimensional finite element arbitrary Lagrangian–Eulerian method for
1324 : : shock hydrodynamics on unstructured grids, Computers & Fluids, 92: 172-187,
1325 [ + - ][ + - ]: 1333 : 2014.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1326 : :
1327 : : keywords.insert({"move",
1328 : : "Start configuration block configuring surface movement in ALE",
1329 : : R"(This keyword is used to introduce a move block, used to
1330 [ + - ][ + - ]: 1333 : configure surface movement for ALE simulations.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1331 : :
1332 : : keywords.insert({"fntype",
1333 : : "Select how a user-defined function is interpreted",
1334 : : R"(This keyword is used to select how a user-defined function should be
1335 [ + - ][ + - ]: 1333 : interpreted.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1336 : :
1337 : : keywords.insert({"fn", "Specify a discrete user-defined function",
1338 : : R"(This keyword is used to specify a user-defined function block with
1339 : : discrete points, listed inside the fn block. Used in ale mesh motion and
1340 [ + - ][ + - ]: 1333 : time-dependent BC specification)", "reals" });
[ + - ][ + - ]
[ + - ][ + - ]
1341 : :
1342 : : keywords.insert({"laplace",
1343 : : "Select the Laplace mesh velocity smoother for ALE",
1344 : : R"(This keyword is used to select the 'Laplace' mesh velocity smoother
1345 [ + - ][ + - ]: 1333 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1346 : :
1347 : : keywords.insert({"helmholtz",
1348 : : "Select the Helmholtz velocity for ALE",
1349 : : R"(This keyword is used to select the a velocity, computed from the
1350 : : Helmholtz-decomposition as the mesh velocity for
1351 : : Arbitrary-Lagrangian-Eulerian (ALE) mesh motion. See J. Bakosi, J. Waltz,
1352 : : N. Morgan, Improved ALE mesh velocities for complex flows, Int. J. Numer.
1353 [ + - ][ + - ]: 1333 : Meth. Fl., 1-10, 2017, https://doi.org/10.1002/fld.4403.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1354 : :
1355 : : keywords.insert({"none", "Select none option",
1356 : : R"(This keyword is used to select the 'none' option from a list of
1357 [ + - ][ + - ]: 1333 : configuration options.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1358 : :
1359 : : keywords.insert({"sine",
1360 : : "Prescribe sinusoidal mesh velocity for ALE",
1361 : : R"(This keyword is used to prescribe a sinusoidal mesh velocity
1362 [ + - ][ + - ]: 1333 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1363 : :
1364 : : keywords.insert({"fluid", "Select the fluid velocity for ALE",
1365 : : R"(This keyword is used to select the 'fluid' velocity as the mesh velocity
1366 [ + - ][ + - ]: 1333 : for Arbitrary-Lagrangian-Eulerian (ALE) mesh motion.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1367 : :
1368 : : // -----------------------------------------------------------------------
1369 : : // h/p adaptation objects
1370 : : // -----------------------------------------------------------------------
1371 : :
1372 : : keywords.insert({"amr",
1373 : : "Start configuration block configuring adaptive mesh refinement",
1374 : : R"(This keyword is used to introduce the amr block, used to
1375 [ + - ][ + - ]: 1333 : configure adaptive mesh refinement.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1376 : :
1377 : : keywords.insert({"t0ref", "Enable mesh refinement at t<0",
1378 : : R"(This keyword is used to enable initial mesh refinement, which can be
1379 : : configured to perform multiple levels of mesh refinement based on various
1380 [ + - ][ + - ]: 1333 : refinement criteria and configuration settings.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
1381 : :
1382 : : keywords.insert({"dtref", "Enable mesh refinement at t>0",
1383 : : R"(This keyword is used to enable solution-adaptive mesh refinement during
1384 [ + - ][ + - ]: 1333 : time stepping.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
1385 : :
1386 : : keywords.insert({"dtref_uniform",
1387 : : "Enable mesh refinement at t>0 but only perform uniform refinement",
1388 : : R"(This keyword is used to force uniform-only solution-adaptive mesh
1389 [ + - ][ + - ]: 1333 : refinement during time stepping.)", "bool"});
[ + - ][ + - ]
[ + - ][ + - ]
1390 : :
1391 : : keywords.insert({"dtfreq",
1392 : : "Set mesh refinement frequency during time stepping",
1393 : : R"(This keyword is used to configure the frequency of mesh refinement
1394 [ + - ][ + - ]: 1333 : during time stepping.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1395 : :
1396 : : keywords.insert({"maxlevels",
1397 : : "Set maximum allowed mesh refinement levels",
1398 : : R"(This keyword is used to configure the maximum allowed mesh refinement
1399 [ + - ][ + - ]: 1333 : levels.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1400 : :
1401 : : keywords.insert({"initial",
1402 : : "Configure initial mesh refinement (before time stepping)",
1403 : : R"(This keyword is used to add to a list of initial mesh refinement types
1404 : : that happens before t = 0. Allowed options are 'uniform',
1405 : : 'uniform_derefine', 'initial_conditions', 'coords', 'edgelist')",
1406 [ + - ][ + - ]: 1333 : "vector of strings"});
[ + - ][ + - ]
[ + - ][ + - ]
1407 : :
1408 : : keywords.insert({"coords",
1409 : : "Configure initial refinement using coordinate planes",
1410 : : R"(This keyword can be used to configure entire volumes on a given side of
1411 : : a plane in 3D space. The keyword introduces an coords block within
1412 : : an amr block. All edges of the input mesh will be tagged for refinement
1413 : : whose end-points lie within the given ranges.
1414 : : Example: 'xminus 0.5' refines all edges whose end-point coordinates are
1415 : : less than 0.5. Multiple specifications are understood by combining with
1416 : : a logical AND. That is: 'xminus 0.5 yplus 0.3' refines all edges whose
1417 : : end-point x coordinates are less than 0.5 AND y coordinates are larger than
1418 [ + - ][ + - ]: 1333 : 0.3.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1419 : :
1420 : : keywords.insert({"xminus",
1421 : : "Configure initial refinement for coordinates lower than an x-normal plane",
1422 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1423 : : whose end-points are less than the x coordinate of a plane perpendicular
1424 : : to coordinate x in 3D space. The keyword must be used in a coords-block
1425 : : within an amr-block with syntax 'xminus <real>'. All edges of the
1426 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1427 : : the real number given. Example: 'xminus 0.5' refines all edges whose end-point
1428 [ + - ][ + - ]: 1333 : x-coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1429 : :
1430 : : keywords.insert({"xplus",
1431 : : "Configure initial refinement for coordinates larger than an x-normal plane",
1432 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1433 : : whose end-points are larger than the x coordinate of a plane perpendicular
1434 : : to coordinate x in 3D space. The keyword must be used in a coords-block
1435 : : within an amr-block with syntax 'xplus <real>'. All edges of the
1436 : : input mesh will be tagged for refinement whose end-points lie larger than
1437 : : (+) the real number given. Example: 'xplus 0.5' refines all edges whose
1438 [ + - ][ + - ]: 1333 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1439 : :
1440 : : keywords.insert({"yminus",
1441 : : "Configure initial refinement for coordinates lower than an y-normal plane",
1442 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1443 : : whose end-points are less than the y coordinate of a plane perpendicular
1444 : : to coordinate y in 3D space. The keyword must be used in a coords-block
1445 : : within an amr-block with syntax 'yminus <real>'. All edges of the
1446 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1447 : : the real number given. Example: 'yminus 0.5' refines all edges whose end-point
1448 [ + - ][ + - ]: 1333 : coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1449 : :
1450 : : keywords.insert({"yplus",
1451 : : "Configure initial refinement for coordinates larger than an y-normal plane",
1452 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1453 : : whose end-points are larger than the y coordinate of a plane perpendicular
1454 : : to coordinate y in 3D space. The keyword must be used in a coords-block
1455 : : within an amr-block with syntax 'yplus <real>'. All edges of the
1456 : : input mesh will be tagged for refinement whose end-points lie larger than
1457 : : (+) the real number given. Example: 'yplus 0.5' refines all edges whose
1458 [ + - ][ + - ]: 1333 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1459 : :
1460 : : keywords.insert({"zminus",
1461 : : "Configure initial refinement for coordinates lower than an z-normal plane",
1462 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1463 : : whose end-points are less than the z coordinate of a plane perpendicular
1464 : : to coordinate z in 3D space. The keyword must be used in a coords-block
1465 : : within an amr-block with syntax 'zminus <real>'. All edges of the
1466 : : input mesh will be tagged for refinement whose end-points lie less than (-)
1467 : : the real number given. Example: 'zminus 0.5' refines all edges whose end-point
1468 [ + - ][ + - ]: 1333 : coordinates are less than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1469 : :
1470 : : keywords.insert({"zplus",
1471 : : "Configure initial refinement for coordinates larger than an z-normal plane",
1472 : : R"(This keyword can be used to configure a mesh refinement volume for edges
1473 : : whose end-points are larger than the z coordinate of a plane perpendicular
1474 : : to coordinate z in 3D space. The keyword must be used in a coords-block
1475 : : within an amr-block with syntax 'zplus <real>'. All edges of the
1476 : : input mesh will be tagged for refinement whose end-points lie larger than
1477 : : (+) the real number given. Example: 'zplus 0.5' refines all edges whose
1478 [ + - ][ + - ]: 1333 : end-point coordinates are larger than 0.5.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1479 : :
1480 : : keywords.insert({"edgelist",
1481 : : "Configure edge-node pairs for initial refinement",
1482 : : R"(This keyword can be used to configure a list of edges that are explicitly
1483 : : tagged for initial refinement during setup in inciter. The keyword
1484 : : introduces an edgelist block within an amr block and must
1485 : : contain a list of integer pairs, i.e., the number of ids must be even,
1486 : : denoting the end-points of the nodes (=edge) which should be tagged for
1487 [ + - ][ + - ]: 1333 : refinement.)", "vector of uints"});
[ + - ][ + - ]
[ + - ][ + - ]
1488 : :
1489 : : keywords.insert({"error",
1490 : : "Configure the error type for solution-adaptive mesh refinement",
1491 : : R"(This keyword is used to select the algorithm used to estimate the error
1492 : : for solution-adaptive mesh refinement. Available options are 'jump' and
1493 [ + - ][ + - ]: 1333 : 'hessian')", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1494 : :
1495 : : keywords.insert({"refvar",
1496 : : "Configure dependent variables used for adaptive mesh refinement",
1497 : : R"(This keyword is used to configured a list of dependent variables that
1498 : : trigger adaptive mesh refinement based on estimating their numerical error.
1499 : : These refinement variables are used for both initial (i.e., before time
1500 : : stepping) mesh refinement as well as during time stepping. Only previously
1501 : : (i.e., earlier in the input file) selected dependent variables can be
1502 : : configured as refinement variables. Dependent variables are required to be
1503 : : defined in all equation system configuration blocks, e.g., transport ...
1504 : : end, by using the 'depvar' keyword. Example: transport depvar c end amr
1505 : : refvar c end end. Selecting a particular scalar component in a system is
1506 : : done by appending the equation number to the refvar: Example: transport
1507 : : depvar q ncomp 3 end amr refvar q1 q2 end end, which configures two
1508 : : refinement variables: the first and third scalar component of the previously
1509 [ + - ][ + - ]: 1333 : configured transport equation system.)", "vector of char"});
[ + - ][ + - ]
[ + - ][ + - ]
1510 : :
1511 : : keywords.insert({"tol_refine", "Configure refine tolerance",
1512 : : R"(This keyword is used to set the tolerance used to tag an edge for
1513 [ + - ][ + - ]: 1333 : refinement if the relative error exceeds this value.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1514 : :
1515 : : keywords.insert({"tol_derefine",
1516 : : "Configure derefine tolerance",
1517 : : R"(This keyword is used to set the tolerance used to tag an edge for
1518 [ + - ][ + - ]: 1333 : derefinement if the relative error is below this value.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1519 : :
1520 : : keywords.insert({"uniform",
1521 : : "Select uniform initial mesh refinement",
1522 : : R"(This keyword is used to select uniform initial mesh refinement.)",
1523 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1524 : :
1525 : : keywords.insert({"uniform_derefine",
1526 : : "Select uniform initial mesh de-refinement",
1527 : : R"(This keyword is used to select uniform initial mesh de-refinement.)",
1528 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1529 : :
1530 : : keywords.insert({"initial_conditions",
1531 : : "Select initial-conditions-based initial mesh refinement",
1532 : : R"(This keyword is used to select initial-conditions-based initial mesh
1533 [ + - ][ + - ]: 1333 : refinement.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1534 : :
1535 : : keywords.insert({"jump",
1536 : : "Error estimation based on the solution jump normalized by solution value",
1537 : : R"(This keyword is used to select the jump-based error indicator for
1538 : : solution-adaptive mesh refinement. The error is estimated by computing the
1539 : : magnitude of the jump in the solution value normalized by the solution
1540 [ + - ][ + - ]: 1333 : value.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1541 : :
1542 : : keywords.insert({"hessian",
1543 : : "Error estimation based on the Hessian normalized by solution value",
1544 : : R"(This keyword is used to select the Hessian-based error indicator for
1545 : : solution-adaptive mesh refinement. The error is estimated by computing the
1546 : : Hessian (2nd derivative matrix) of the solution normalized by sum of the
1547 [ + - ][ + - ]: 1333 : absolute values of the gradients at edges-end points.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1548 : :
1549 : : keywords.insert({"pref",
1550 : : "Start configuration block configuring p-adaptive refinement",
1551 : : R"(This keyword is used to introduce the pref block, to
1552 [ + - ][ + - ]: 1333 : configure p-adaptive refinement)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1553 : :
1554 : : keywords.insert({"indicator",
1555 : : "Configure the specific adaptive indicator for p-adaptive DG scheme",
1556 : : R"(This keyword can be used to configure a specific type of adaptive
1557 : : indicator for p-adaptive refinement of the DG scheme. The keyword must
1558 : : be used in a pref block. Available options are 'pref_spectral_decay' and
1559 [ + - ][ + - ]: 1333 : 'pref_non_conformity'.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1560 : :
1561 : : keywords.insert({"ndofmax",
1562 : : "Configure the maximum number of degree of freedom for p-adaptive DG",
1563 : : R"(This keyword can be used to configure a maximum number of degree of
1564 : : freedom for p-adaptive refinement of the DG scheme. The keyword must
1565 [ + - ][ + - ]: 1333 : be used in a pref block.)", "uint either 4 or 10"});
[ + - ][ + - ]
[ + - ][ + - ]
1566 : :
1567 : : keywords.insert({"tolref",
1568 : : "Configure the tolerance for p-refinement for p-adaptive DG",
1569 : : R"(This keyword can be used to configure a tolerance for p-adaptive
1570 : : refinement for the DG scheme. The keyword must be used in a pref
1571 : : block. All elements with a refinement indicator larger than this
1572 [ + - ][ + - ]: 1333 : tolerance will be p-refined.)", "real between 0 and 1"});
[ + - ][ + - ]
[ + - ][ + - ]
1573 : :
1574 : : keywords.insert({"spectral_decay",
1575 : : "Select the spectral-decay indicator for p-adaptive DG scheme",
1576 : : R"(This keyword is used to select the spectral-decay indicator used for
1577 : : p-adaptive discontinuous Galerkin (DG) discretization used in inciter.
1578 : : See Control/Inciter/Options/PrefIndicator.hpp for other valid options.)",
1579 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1580 : :
1581 : : keywords.insert({"non_conformity",
1582 : : "Select the non-conformity indicator for p-adaptive DG scheme",
1583 : : R"(This keyword is used to select the non-conformity indicator used for
1584 : : p-adaptive discontinuous Galerkin (DG) discretization used in inciter.
1585 : : See Control/Inciter/Options/PrefIndicator.hpp for other valid options.)",
1586 [ + - ][ + - ]: 1333 : "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1587 : :
1588 : : // -----------------------------------------------------------------------
1589 : : // boundary condition options
1590 : : // -----------------------------------------------------------------------
1591 : :
1592 : : keywords.insert({"bc",
1593 : : "Start configuration block for boundary conditions",
1594 : : R"(This keyword is used to introduce the bc block, used for
1595 : : boundary conditions. This is a vector block, where each vector entry
1596 [ + - ][ + - ]: 1333 : specifies BCs for a particular mesh)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1597 : :
1598 : : keywords.insert({"mesh",
1599 : : "List meshes on which the following BCs apply",
1600 : : R"(This keyword is used to list multiple meshes on which the boundary
1601 : : conditions listed in this particular bc-block apply.)",
1602 [ + - ][ + - ]: 1333 : "vector of uints"});
[ + - ][ + - ]
[ + - ][ + - ]
1603 : :
1604 : : keywords.insert({"dirichlet",
1605 : : "List sidesets with Dirichlet boundary conditions",
1606 : : R"(This keyword is used to list Dirichlet sidesets.
1607 : : This keyword is used to list multiple sidesets on
1608 : : which a prescribed Dirichlet BC is then applied. Such prescribed BCs
1609 : : at each point in space and time are evaluated using a built-in function,
1610 [ + - ][ + - ]: 1333 : e.g., using the method of manufactured solutions.)", "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1611 : :
1612 : : keywords.insert({"symmetry",
1613 : : "List sidesets with symmetry boundary conditions",
1614 : : R"(This keyword is used to list (multiple) symmetry BC sidesets.)",
1615 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1616 : :
1617 : : keywords.insert({"inlet",
1618 : : "List sidesets with inlet boundary conditions",
1619 : : R"(This keyword is used to list (multiple) inlet BC sidesets.)",
1620 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1621 : :
1622 : : keywords.insert({"outlet",
1623 : : "List sidesets with outlet boundary conditions",
1624 : : R"(This keyword is used to list (multiple) outlet BC sidesets.)",
1625 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1626 : :
1627 : : keywords.insert({"farfield",
1628 : : "List sidesets with farfield boundary conditions",
1629 : : R"(This keyword is used to list (multiple) farfield BC sidesets.
1630 : : Keywords allowed in a bc_farfield block are 'density', 'velocity',
1631 [ + - ][ + - ]: 1333 : 'pressure')", "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1632 : :
1633 : : keywords.insert({"extrapolate",
1634 : : "List sidesets with Extrapolation boundary conditions",
1635 : : R"(This keyword is used to list (multiple) extrapolate BC sidesets.)",
1636 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1637 : :
1638 : : keywords.insert({"noslipwall",
1639 : : "List sidesets with no-slip wall boundary conditions",
1640 : : R"(This keyword is used to list (multiple) no-slip wall BC sidesets.)",
1641 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1642 : :
1643 : : keywords.insert({"stag",
1644 : : "List sidesets with stagnation boundary conditions",
1645 : : R"(This keyword is used to list (multiple) stagnation BC sidesets.)",
1646 [ + - ][ + - ]: 1333 : "vector of uint(s)"});
[ + - ][ + - ]
[ + - ][ + - ]
1647 : :
1648 : : keywords.insert({"timedep",
1649 : : "Start configuration block describing time dependent boundary conditions",
1650 : : R"(This keyword is used to introduce a bc_timedep block, used to
1651 : : specify the configuration of time dependent boundary conditions for a
1652 : : partial differential equation. A discrete function in time t in the form
1653 : : of a table with 6 columns (t, pressure(t), density(t), vx(t), vy(t), vz(t))
1654 : : is expected inside a fn ... end block, specified within the bc_timedep
1655 : : block. Multiple such bc_timedep blocks can be specified for different
1656 [ + - ][ + - ]: 1333 : time dependent BCs on different groups of side sets.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1657 : :
1658 : : keywords.insert({"radius", "Specify a radius",
1659 : : R"(This keyword is used to specify a radius, used, e.g., in specifying a
1660 : : point in 3D space for setting a stagnation (velocity vector = 0).)",
1661 [ + - ][ + - ]: 1333 : "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1662 : :
1663 : : keywords.insert({"velocity", "Specify velocity",
1664 : : R"(This keyword is used to configure a velocity vector used in a
1665 : : context-specific way, e.g., for boundary or initial conditions, or
1666 [ + - ][ + - ]: 1333 : specifying overset mesh velocity.)", "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1667 : :
1668 : : // -----------------------------------------------------------------------
1669 : : // IC object
1670 : : // -----------------------------------------------------------------------
1671 : :
1672 : : keywords.insert({"ic",
1673 : : "Introduce an ic block used to configure initial conditions",
1674 : : R"(This keyword is used to introduce an ic block used to set initial
1675 [ + - ][ + - ]: 1333 : conditions.)", "block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1676 : :
1677 : : keywords.insert({"materialid", "Specify material id",
1678 : : R"(This keyword is used to configure the material id within an IC box,
1679 : : IC mesh-block, farfield BC, or in the background as a part of the
1680 [ + - ][ + - ]: 1333 : initialization.)", "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1681 : :
1682 : : keywords.insert({"temperature", "Specify temperature",
1683 : : R"(This keyword is used to configure temperature, used for, e.g.,
1684 [ + - ][ + - ]: 1333 : boundary or initial conditions.)" , "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1685 : :
1686 : : keywords.insert({"mass_fractions", "Specify species mass fractions",
1687 : : R"(This keyword is used to configure species mass fractions, used for,
1688 [ + - ][ + - ]: 1333 : e.g., boundary or initial conditions.)" , "vector of reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1689 : :
1690 : : keywords.insert({"box",
1691 : : "Introduce a box block used to assign initial conditions",
1692 : : R"(This keyword is used to introduce a IC box block used to assign
1693 : : initial conditions within a box given by spatial coordinates.)",
1694 [ + - ][ + - ]: 1333 : "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1695 : :
1696 : : keywords.insert({"meshblock",
1697 : : "Introduce a meshblock block used to assign initial conditions",
1698 : : R"(This keyword is used to introduce a IC meshblock block used to
1699 : : assign initial conditions within a mesh block specified in the mesh file.)",
1700 [ + - ][ + - ]: 1333 : "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1701 : :
1702 : : keywords.insert({"blockid", "Specify mesh block id",
1703 : : R"(This keyword is used to configure the mesh block id within the
1704 : : meshblock-block as a part of the initialization. It is strongly
1705 : : recommended to use contiguous block ids in mesh file starting from 1.)",
1706 [ + - ][ + - ]: 1333 : "uint"});
[ + - ][ + - ]
[ + - ][ + - ]
1707 : :
1708 : : keywords.insert({"volume", "Specify volume",
1709 : : R"(This keyword is used to configure the volume of a meshblock.)",
1710 [ + - ][ + - ]: 1333 : "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1711 : :
1712 : : keywords.insert({"mass", "Specify mass",
1713 : : R"(This keyword is used to configure the mass within a box/meshblock.)",
1714 [ + - ][ + - ]: 1333 : "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1715 : :
1716 : : keywords.insert({"energy", "Specify energy per unit mass",
1717 : : R"(This keyword is used to configure energy per unit mass, used for, e.g.,
1718 [ + - ][ + - ]: 1333 : boundary or initial conditions.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1719 : :
1720 : : keywords.insert({"energy_content", "Specify energy per unit volume",
1721 : : R"(This keyword is used to configure energy per unit volume, used for
1722 [ + - ][ + - ]: 1333 : initial conditions.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1723 : :
1724 : : keywords.insert({"xmin", "Minimum x coordinate",
1725 : : R"(This keyword used to configure a minimum x coordinate to specify
1726 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1727 : :
1728 : : keywords.insert({"xmax", "Maximum x coordinate",
1729 : : R"(This keyword used to configure a maximum x coordinate to specify
1730 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1731 : :
1732 : : keywords.insert({"ymin", "Minimum y coordinate",
1733 : : R"(This keyword used to configure a minimum y coordinate to specify
1734 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1735 : :
1736 : : keywords.insert({"ymax", "Maximum y coordinate",
1737 : : R"(This keyword used to configure a maximum y coordinate to specify
1738 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1739 : :
1740 : : keywords.insert({"zmin", "Minimum z coordinate",
1741 : : R"(This keyword used to configure a minimum z coordinate to specify
1742 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1743 : :
1744 : : keywords.insert({"zmax", "Maximum z coordinate",
1745 : : R"(This keyword used to configure a maximum z coordinate to specify
1746 [ + - ][ + - ]: 1333 : a box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1747 : :
1748 : : keywords.insert({"orientation", "Configure orientation",
1749 : : R"(Configure orientation of an IC box for rotation about centroid of box.)",
1750 [ + - ][ + - ]: 1333 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1751 : :
1752 : : keywords.insert({"initiate", "Initiation type",
1753 : : R"(This keyword is used to select an initiation type to configure how
1754 : : values are assigned for a box/meshblock initialization. This can be used
1755 : : to specify, how the values are assigned to mesh nodes within a box. Uses:
1756 : : (1) impulse: assign the full values at t=0 for all points in a box,
1757 : : (2) linear: use a linear function in time and space, configured with an
1758 : : initiation point in space, a constant velocity of the growing spherical
1759 : : front in time (and space) linearly, and width of the front and assigns
1760 : : values to mesh points falling within the growing spherical shell inside
1761 [ + - ][ + - ]: 1333 : a configured box.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1762 : :
1763 : : keywords.insert({"init_time","Specify the initialization time",
1764 : : R"(This keyword is used to specify the time at which the propagating front
1765 : : is initialized for a mesh block or box IC, with 'initiate linear' type.
1766 : : Delays in initializing separate mesh blocks or boxes can be achieved using
1767 [ + - ][ + - ]: 1333 : different initialization times.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1768 : :
1769 : : keywords.insert({"front_width", "Specify a front width",
1770 : : R"(This keyword is used to specify the width of the propagating front for
1771 : : a mesh block or box IC, with 'initiate linear' type. The suggested value
1772 : : of the front width is about 4-5 times the mesh size inside the mesh block
1773 [ + - ][ + - ]: 1333 : or box.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1774 : :
1775 : : keywords.insert({"front_speed", "Specify a front speed",
1776 : : R"(This keyword is used to specify the speed at which a front propagates
1777 [ + - ][ + - ]: 1333 : for a mesh block or box IC, with 'initiate linear' type.)", "real"});
[ + - ][ + - ]
[ + - ][ + - ]
1778 : :
1779 : : keywords.insert({"impulse",
1780 : : "Select the impulse initiation type, for a box/meshblock IC",
1781 : : R"(This keyword can be used to select the 'impulse' initiation/assignment
1782 : : type for box initial conditions. It simply assigns the prescribed values
1783 [ + - ][ + - ]: 1333 : to all mesh points within a configured box at t=0.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1784 : :
1785 : : keywords.insert({"linear",
1786 : : "Select the linear initiation type, for a box/meshblock IC",
1787 : : R"(This keyword is be used to specify the 'linear' initiation parameters
1788 : : for a particular box or meshblock, as a part of the 'energy_pill'
1789 : : initialization. Linear initiation uses a linear function in time and space,
1790 : : configured with an initiation point in space, a constant velocity of the
1791 : : growing spherical front in time (and space) linearly, and width of the front
1792 : : and assigns values to mesh points falling within the growing spherical shell
1793 : : inside a configured box or meshblock. The following keywords are required
1794 : : in the box/meshblock block if 'linear' is used: 'init_time',
1795 [ + - ][ + - ]: 1333 : 'front_width', 'front_speed')"});
[ + - ][ + - ]
[ + - ][ + - ]
1796 : :
1797 : : // -----------------------------------------------------------------------
1798 : : // Overset mesh object
1799 : : // -----------------------------------------------------------------------
1800 : :
1801 : : keywords.insert({"mesh",
1802 : : "Start configuration block assigning a mesh to a solver",
1803 : : R"(This keyword is used to introduce a mesh block, used to
1804 [ + - ][ + - ]: 1333 : assign and configure a mesh to a solver.)", "vector block-title"});
[ + - ][ + - ]
[ + - ][ + - ]
1805 : :
1806 : : keywords.insert({"filename", "Set filename",
1807 [ + - ][ + - ]: 1333 : R"(Set filename, e.g., mesh filename for solver coupling.)", "string"});
[ + - ][ + - ]
[ + - ][ + - ]
1808 : :
1809 : : keywords.insert({"location", "Configure location",
1810 : : R"(Configure location of a mesh relative to another.)",
1811 [ + - ][ + - ]: 1333 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1812 : :
1813 : : keywords.insert({"orientation", "Configure orientation",
1814 : : R"(Configure orientation of a mesh relative to another.)",
1815 [ + - ][ + - ]: 1333 : "vector of 3 reals"});
[ + - ][ + - ]
[ + - ][ + - ]
1816 : :
1817 : : // -----------------------------------------------------------------------
1818 : : // pre-configured problems
1819 : : // -----------------------------------------------------------------------
1820 : :
1821 : : keywords.insert({"user_defined",
1822 : : "Select user-defined specification for a problem",
1823 : : R"(This keyword is used to select the user-defined specification for an
1824 : : option. This could be a 'problem' to be solved by a partial differential
1825 : : equation, but can also be a 'user-defined' mesh velocity specification for
1826 [ + - ][ + - ]: 1333 : ALE mesh motion.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1827 : :
1828 : : keywords.insert({"shear_diff",
1829 : : "Select the shear + diffusion test problem ",
1830 : : R"(This keyword is used to select the shear diffusion test problem. The
1831 : : initial and boundary conditions are specified to set up the test problem
1832 : : suitable to exercise and test the advection and diffusion terms of the
1833 [ + - ][ + - ]: 1333 : scalar transport equation.)" });
[ + - ][ + - ]
[ + - ][ + - ]
1834 : :
1835 : : keywords.insert({"slot_cyl",
1836 : : "Select Zalesak's slotted cylinder test problem",
1837 : : R"(This keyword is used to select Zalesak's slotted cylinder test
1838 : : problem. The initial and boundary conditions are specified to set up the
1839 : : test problem suitable to exercise and test the advection and diffusion
1840 [ + - ][ + - ]: 1333 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1841 : :
1842 : : keywords.insert({"gauss_hump",
1843 : : "Select advection of 2D Gaussian hump test problem",
1844 : : R"(This keyword is used to select the advection of 2D Gaussian hump test
1845 : : problem. The initial and boundary conditions are specified to set up the
1846 : : test problem suitable to exercise and test the advection
1847 [ + - ][ + - ]: 1333 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1848 : :
1849 : : keywords.insert({"cyl_advect",
1850 : : "Select advection of cylinder test problem",
1851 : : R"(This keyword is used to select the advection of cylinder test
1852 : : problem. The initial and boundary conditions are specified to set up the
1853 : : test problem suitable to exercise and test the advection
1854 [ + - ][ + - ]: 1333 : terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1855 : :
1856 : : keywords.insert({"cyl_vortex",
1857 : : "Select deformation of cylinder in a vortex test problem",
1858 : : R"(This keyword is used to select the test problem which deforms a cylinder
1859 : : in a vortical velocity field. The initial and boundary conditions are
1860 : : specified to set up the test problem suitable to exercise and test the
1861 [ + - ][ + - ]: 1333 : advection terms of the scalar transport equation.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1862 : :
1863 : : keywords.insert({"vortical_flow",
1864 : : "Select the vortical flow test problem ",
1865 : : R"(This keyword is used to select the vortical flow test problem. The
1866 : : purpose of this test problem is to test velocity errors generated by spatial
1867 : : operators in the presence of 3D vorticity and in particluar the
1868 : : superposition of planar and vortical flows, analogous to voritcity
1869 : : stretching. For more details, see Waltz,
1870 : : et. al, "Manufactured solutions for the three-dimensional Euler equations
1871 : : with relevance to Inertial Confinement Fusion", Journal of Computational
1872 [ + - ][ + - ]: 1333 : Physics 267 (2014) 196-209.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1873 : :
1874 : : keywords.insert({"nl_energy_growth",
1875 : : "Select the nonlinear energy growth test problem",
1876 : : R"(This keyword is used to select the nonlinear energy growth test problem.
1877 : : The purpose of this test problem is to test nonlinear, time dependent energy
1878 : : growth and the subsequent development of pressure gradients due to coupling
1879 : : between the internal energy and the equation of state. For more details,
1880 : : see Waltz, et. al, "Manufactured
1881 : : solutions for the three-dimensional Euler equations with relevance to
1882 : : Inertial Confinement Fusion", Journal of Computational Physics 267 (2014)
1883 [ + - ][ + - ]: 1333 : 196-209.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1884 : :
1885 : : keywords.insert({"rayleigh_taylor",
1886 : : "Select the Rayleigh-Taylor test problem ",
1887 : : R"(This keyword is used to select the Rayleigh-Taylor unstable configuration
1888 : : test problem. The purpose of this test problem is to assess time dependent
1889 : : fluid motion in the presence of Rayleigh-Taylor unstable conditions, i.e.
1890 : : opposing density and pressure gradients.
1891 : : For more details, see Waltz, et. al, "Manufactured solutions for the
1892 : : three-dimensional Euler equations with relevance to Inertial Confinement
1893 [ + - ][ + - ]: 1333 : Fusion", Journal of Computational Physics 267 (2014) 196-209.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1894 : :
1895 : : keywords.insert({"taylor_green",
1896 : : "Select the Taylor-Green test problem ",
1897 : : R"(This keyword is used to select the Taylor-Green vortex test problem. The
1898 : : purpose of this problem is to test time accuracy and the correctness of the
1899 : : discretization of the viscous term in the Navier-Stokes equation. For more
1900 : : details on the flow, see G.I. Taylor, A.E.
1901 : : Green, "Mechanism of the Production of Small Eddies from Large Ones", Proc.
1902 : : R. Soc. Lond. A 1937 158 499-521; DOI: 10.1098/rspa.1937.0036. Published 3
1903 [ + - ][ + - ]: 1333 : February 1937.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1904 : :
1905 : : keywords.insert({"sod_shocktube",
1906 : : "Select the Sod shock-tube test problem ",
1907 : : R"(This keyword is used to select the Sod shock-tube test problem. The
1908 : : purpose of this test problem is to test the correctness of the
1909 : : approximate Riemann solver and its shock and interface capturing
1910 : : capabilities. For more details, see
1911 : : G. A. Sod, "A Survey of Several Finite Difference Methods for Systems of
1912 : : Nonlinear Hyperbolic Conservation Laws", J. Comput. Phys., 27 (1978)
1913 [ + - ][ + - ]: 1333 : 1–31.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1914 : :
1915 : : keywords.insert({"rotated_sod_shocktube",
1916 : : "Select the rotated Sod shock-tube test problem ",
1917 : : R"(This keyword is used to select the rotated Sod shock-tube test problem.
1918 : : This the same as Sod shocktube but the geometry is rotated about X, Y, Z
1919 : : each by 45 degrees (in that order) so that none of the domain boundary align
1920 : : with any of the coordinate directions. The purpose of this test problem is
1921 : : to test the correctness of the approximate Riemann solver and its shock and
1922 : : interface capturing capabilities in an arbitrarily oriented geometry.
1923 : : For more details on the Sod
1924 : : problem, see G. A. Sod, "A Survey of Several Finite Difference Methods for
1925 : : Systems of Nonlinear Hyperbolic Conservation Laws", J. Comput. Phys., 27
1926 [ + - ][ + - ]: 1333 : (1978) 1–31.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1927 : :
1928 : : keywords.insert({"shedding_flow",
1929 : : "Select the Shedding flow test problem ",
1930 : : R"(This keyword is used to select the Shedding flow test problem. It
1931 : : describe a quasi-2D inviscid flow over a triangular wedge in tetrahedron
1932 : : grid. The purpose of this test problem is to test the capability of DG
1933 : : scheme for retaining the shape of vortices and also different error
1934 : : indicator behavior for this external flow problem when p-adaptive DG scheme
1935 [ + - ][ + - ]: 1333 : is applied.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1936 : :
1937 : : keywords.insert({"sedov_blastwave",
1938 : : "Select the Sedov blast-wave test problem ",
1939 : : R"(This keyword is used to select the Sedov blast-wave test problem. The
1940 : : purpose of this test problem is to test the correctness of the
1941 : : approximate Riemann solver and its strong shock and interface capturing
1942 [ + - ][ + - ]: 1333 : capabilities.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1943 : :
1944 : : keywords.insert({"interface_advection",
1945 : : "Select the interface advection test problem ",
1946 : : R"(This keyword is used to select the interface advection test problem.
1947 : : The purpose of this test problem is to test the well-balancedness of the
1948 : : multi-material discretization and its interface capturing
1949 [ + - ][ + - ]: 1333 : capabilities.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1950 : :
1951 : : keywords.insert({"gauss_hump_compflow",
1952 : : "Select advection of 2D Gaussian hump test problem",
1953 : : R"(This keyword is used to select the advection of 2D Gaussian hump test
1954 : : problem. The initial and boundary conditions are specified to set up the
1955 : : test problem suitable to exercise and test the advection terms of the
1956 : : Euler equations. The baseline of the density distribution in this testcase
1957 : : is 1 instead of 0 in gauss_hump_transport which enables it to be the
1958 [ + - ][ + - ]: 1333 : regression testcase for p-adaptive DG scheme.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1959 : :
1960 : : keywords.insert({"waterair_shocktube",
1961 : : "Select the water-air shock-tube test problem ",
1962 : : R"(This keyword is used to select the Water-air shock-tube test problem.
1963 : : The purpose of this test problem is to test the correctness of the
1964 : : multi-material pressure relaxation procedure and its interface capturing
1965 : : capabilities. For more details, see
1966 : : Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse
1967 : : interfaces with compressible fluids on unstructured meshes. Journal of
1968 [ + - ][ + - ]: 1333 : Computational Physics, 340, 389-417.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1969 : :
1970 : : keywords.insert({"shock_hebubble",
1971 : : "Select the shock He-bubble test problem ",
1972 : : R"(This keyword is used to select the shock He-bubble test problem. The
1973 : : purpose of this test problem is to test the correctness of the
1974 : : multi-material algorithm and its shock-interface interaction
1975 : : capabilities. For more details, see
1976 : : Quirk, J. J., & Karni, S. (1996). On the dynamics of a shock–bubble
1977 [ + - ][ + - ]: 1333 : interaction. Journal of Fluid Mechanics, 318, 129-163.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1978 : :
1979 : : keywords.insert({"underwater_ex",
1980 : : "Select the underwater explosion test problem ",
1981 : : R"(This keyword is used to select the underwater explosion test problem.
1982 : : The purpose of this test problem is to test the correctness of the
1983 : : multi-material algorithm and its interface capturing capabilities in the
1984 : : presence of strong shocks and large deformations.
1985 : : For more details, see
1986 : : Chiapolino, A., Saurel, R., & Nkonga, B. (2017). Sharpening diffuse
1987 : : interfaces with compressible fluids on unstructured meshes. Journal of
1988 [ + - ][ + - ]: 1333 : Computational Physics, 340, 389-417.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1989 : :
1990 : : keywords.insert({"shockdensity_wave",
1991 : : "Select the shock-density wave test problem ",
1992 : : R"(This keyword is used to select the shock-density wave test problem.
1993 : : THe purpose of this test problem is to assess the accuracy of high order
1994 : : method in predicting the interaction of a density wave with a shock front.
1995 : : For more details, see Yu, L., Matthias
1996 : : I. (2014). Discontinuous Galerkin method for multicomponent chemically
1997 : : reacting flows and combustion. Journal of Computational Physics, 270,
1998 [ + - ][ + - ]: 1333 : 105-137.)"});
[ + - ][ + - ]
[ + - ][ + - ]
1999 : :
2000 : : keywords.insert({"equilinterface_advect",
2001 : : "Select the advection of equilibrium interface problem ",
2002 : : R"(This keyword is used to select the advection of equilibrium interface
2003 : : problem. This is a manufactured problem with source terms with nonlinear
2004 : : solutions near the material interface. Source terms are used to ensure
2005 [ + - ][ + - ]: 1333 : that the conservation laws are satisfied by the manufactured solution.)"});
[ + - ][ + - ]
[ + - ][ + - ]
2006 : :
2007 : : keywords.insert({"sinewave_packet",
2008 : : "Select the advection of sinewave packet problem ",
2009 : : R"(This keyword is used to select the advection of sinewave packet
2010 [ + - ][ + - ]: 1333 : problem.)"});
[ + - ][ + - ]
[ + - ][ + - ]
2011 : :
2012 : : keywords.insert({"richtmyer_meshkov",
2013 : : "Select the Richtmyer-Meshkov instability problem ",
2014 : : R"(This keyword is used to select the Richtmyer-Meshkov instability
2015 [ + - ][ + - ]: 1333 : problem. In this problem, a shock hits a perturbed material interface.)"});
[ + - ][ + - ]
[ + - ][ + - ]
2016 : :
2017 : : // -----------------------------------------------------------------------
2018 : :
2019 : : // Initialize help: fill own keywords
2020 : 1333 : tk::ctr::Info ctrinfoFill(get< tag::cmd, tag::ctrinfo >());
2021 [ + + ]: 317254 : for (const auto& i : keywords) {
2022 [ + - ]: 315921 : ctrinfoFill.fill(i);
2023 : : }
2024 : 1333 : }
2025 : :
2026 : : //! Query scheme centering
2027 : : //! \return Scheme centering
2028 : 189 : tk::Centering centering() const
2029 [ + - ]: 189 : { return ctr::Scheme().centering( get< tag::scheme >() ); }
2030 : :
2031 : : /** @name Pack/Unpack: Serialize InputDeck object for Charm++ */
2032 : : ///@{
2033 : : //! \brief Pack/Unpack serialize member function
2034 : : //! \param[in,out] p Charm++'s PUP::er serializer object reference
2035 : 1766 : void pup( PUP::er& p ) { tk::TaggedTuple< ConfigMembers >::pup(p); }
2036 : : //! \brief Pack/Unpack serialize operator|
2037 : : //! \param[in,out] p Charm++'s PUP::er serializer object reference
2038 : : //! \param[in,out] c InputDeck object reference
2039 : 1766 : friend void operator|( PUP::er& p, InputDeck& c ) { c.pup(p); }
2040 : : //@}
2041 : :
2042 : : };
2043 : :
2044 : : } // ctr::
2045 : : } // inciter::
2046 : :
2047 : : #endif // InputDeck_h
|
