Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
time_integration_utilities.h File Reference
#include <core/parameters.h>
Include dependency graph for time_integration_utilities.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

bool is_steady (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_is_bdf1 (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_is_bdf (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_is_sdirk (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_is_bdf_high_order (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_method_uses_two_previous_solutions (const Parameters::SimulationControl::TimeSteppingMethod method)
bool time_stepping_method_uses_three_previous_solutions (const Parameters::SimulationControl::TimeSteppingMethod method)

Function Documentation

◆ is_steady()

bool is_steady ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method is a steady-state method.

Parameters
methodA time integration method

Definition at line 15 of file time_integration_utilities.h.

References Parameters::SimulationControl::steady.

◆ time_stepping_is_bdf()

bool time_stepping_is_bdf ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method is within the bdf family.

Parameters
methodA time integration method
Returns
true if the method is BDF1, BDF2, BDF3, or steady BDF, false otherwise.

Definition at line 42 of file time_integration_utilities.h.

References Parameters::SimulationControl::bdf1, Parameters::SimulationControl::bdf2, Parameters::SimulationControl::bdf3, and Parameters::SimulationControl::steady_bdf.

◆ time_stepping_is_bdf1()

bool time_stepping_is_bdf1 ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method is within the bdf-1 family.

Parameters
methodA time integration method

Definition at line 26 of file time_integration_utilities.h.

References Parameters::SimulationControl::bdf1, and Parameters::SimulationControl::steady_bdf.

◆ time_stepping_is_bdf_high_order()

bool time_stepping_is_bdf_high_order ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method is within the high-order (>=2) bdf family.

Parameters
methodA time integration method

Definition at line 75 of file time_integration_utilities.h.

References Parameters::SimulationControl::bdf2, and Parameters::SimulationControl::bdf3.

◆ time_stepping_is_sdirk()

bool time_stepping_is_sdirk ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method is within the sdirk family.

Parameters
methodA time integration method
Returns
true if the method is SDIRK, false otherwise.

Definition at line 60 of file time_integration_utilities.h.

References Parameters::SimulationControl::sdirk22, Parameters::SimulationControl::sdirk33, and Parameters::SimulationControl::sdirk45.

◆ time_stepping_method_uses_three_previous_solutions()

bool time_stepping_method_uses_three_previous_solutions ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method requires two additional arrays.

Parameters
methodA time integration method

Definition at line 102 of file time_integration_utilities.h.

References Parameters::SimulationControl::bdf3.

◆ time_stepping_method_uses_two_previous_solutions()

bool time_stepping_method_uses_two_previous_solutions ( const Parameters::SimulationControl::TimeSteppingMethod method)
inline

Determines if the time integration method requires an additional array.

Parameters
methodA time integration method

Definition at line 89 of file time_integration_utilities.h.

References Parameters::SimulationControl::bdf2, and Parameters::SimulationControl::bdf3.