Reference documentation for deal.II version GIT relicensing-43-g3fc2fae7c3 2024-03-03 21:10:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
petsc_ts.cc
Go to the documentation of this file.
1// ------------------------------------------------------------------------
2//
3// SPDX-License-Identifier: LGPL-2.1-or-later
4// Copyright (C) 2023 by the deal.II authors
5//
6// This file is part of the deal.II library.
7//
8// Part of the source code is dual licensed under Apache-2.0 WITH
9// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10// governing the source code and code contributions can be found in
11// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12//
13// ------------------------------------------------------------------------
14
15#ifndef DOXYGEN
16
17# include <deal.II/base/config.h>
18
19# ifdef DEAL_II_WITH_PETSC
20
22# include <deal.II/lac/petsc_ts.templates.h>
23
25
26namespace PETScWrappers
27{
28 void
30 {
31 prm.enter_subsection("Running parameters");
32 prm.add_parameter(
33 "options prefix",
35 "The string indicating the options prefix for command line customization.");
36 prm.add_parameter("solver type",
37 ts_type,
38 "The string indicating the PETSc TS type.");
39 prm.add_parameter("initial time",
41 "The value for the initial time.");
42 prm.add_parameter("final time",
44 "The value for the final time.");
45 prm.add_parameter("initial step size",
47 "The value for the initial time step.");
48 prm.add_parameter("maximum number of steps",
50 "Maximum number of time steps allowed.");
51 prm.add_parameter(
52 "match final time",
54 "Whether or not to exactly stop at final time or step over it.");
55 prm.leave_subsection();
56
57 prm.enter_subsection("Error control");
58 prm.add_parameter("adaptor type",
60 "The string for the TSAdapt type.");
61 prm.add_parameter("minimum step size",
63 "Minimum time step size allowed.");
64 prm.add_parameter("maximum step size",
66 "Maximum time step size allowed.");
67 prm.add_parameter("absolute error tolerance",
69 "Absolute error tolerance.");
70 prm.add_parameter("relative error tolerance",
72 "Absolute error tolerance.");
73 prm.add_parameter("ignore algebraic lte",
75 "Indicate whether or not to suppress algebraic variables "
76 "in the local truncation error test.");
77 prm.leave_subsection();
78 }
79
80} // namespace PETScWrappers
81
82template class PETScWrappers::TimeStepper<>;
87template class PETScWrappers::TimeStepper<
90
91
93
94# endif // DEAL_II_WITH_PETSC
95#endif
void add_parameters(ParameterHandler &prm)
void add_parameter(const std::string &entry, ParameterType &parameter, const std::string &documentation="", const Patterns::PatternBase &pattern= *Patterns::Tools::Convert< ParameterType >::to_pattern(), const bool has_to_be_set=false)
void enter_subsection(const std::string &subsection)
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:502
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:503