Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
time_integration_utilities.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2020-2026 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_time_integration_utilities_h
5#define lethe_time_integration_utilities_h
6
7#include <core/parameters.h>
8
9/**
10 * @brief Determines if the time integration method is a steady-state method
11 *
12 * @param method A time integration method
13 */
14inline bool
19
20/**
21 * @brief Determines if the time integration method is within the bdf-1 family
22 *
23 * @param method A time integration method
24 */
25inline bool
33
34/**
35 * @brief Determines if the time integration method is within the bdf family
36 *
37 * @param method A time integration method
38 *
39 * @return true if the method is BDF1, BDF2, BDF3, or steady BDF, false otherwise.
40 */
41inline bool
51
52/**
53 * @brief Determines if the time integration method is within the sdirk family
54 *
55 * @param method A time integration method
56 *
57 * @return true if the method is SDIRK, false otherwise.
58 */
59inline bool
68
69/**
70 * @brief Determines if the time integration method is within the high-order (>=2) bdf family
71 *
72 * @param method A time integration method
73 */
74inline bool
81
82
83/**
84 * @brief Determines if the time integration method requires an additional array
85 *
86 * @param method A time integration method
87 */
88inline bool
95
96/**
97 * @brief Determines if the time integration method requires two additional arrays
98 *
99 * @param method A time integration method
100 */
101inline bool
107
108#endif
bool is_steady(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method is a steady-state method.
bool time_stepping_is_bdf1(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method is within the bdf-1 family.
bool time_stepping_is_bdf(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method is within the bdf family.
bool time_stepping_is_sdirk(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method is within the sdirk family.
bool time_stepping_method_uses_three_previous_solutions(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method requires two additional arrays.
bool time_stepping_is_bdf_high_order(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method is within the high-order (>=2) bdf family.
bool time_stepping_method_uses_two_previous_solutions(const Parameters::SimulationControl::TimeSteppingMethod method)
Determines if the time integration method requires an additional array.