Reference documentation for deal.II version GIT relicensing-12-g89ba5bf9db 2024-02-24 00:00:03+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
Public Types | Public Member Functions | Public Attributes | List of all members
PETScWrappers::TimeStepperData Class Reference

#include <deal.II/lac/petsc_ts.h>

Public Types

using real_type = PetscReal
 

Public Member Functions

 TimeStepperData (const std::string &options_prefix="", const std::string &ts_type="", const real_type initial_time=0.0, const real_type final_time=0.0, const real_type initial_step_size=0.0, const int max_steps=-1, const bool match_step=false, const std::string &ts_adapt_type="none", const real_type minimum_step_size=-1.0, const real_type maximum_step_size=-1.0, const real_type absolute_tolerance=-1.0, const real_type relative_tolerance=-1.0, const bool ignore_algebraic_lte=true)
 
void add_parameters (ParameterHandler &prm)
 

Public Attributes

std::string options_prefix
 
std::string ts_type
 
real_type initial_time
 
real_type final_time
 
real_type initial_step_size
 
int max_steps
 
bool match_step
 
std::string ts_adapt_type
 
real_type minimum_step_size
 
real_type maximum_step_size
 
real_type absolute_tolerance
 
real_type relative_tolerance
 
bool ignore_algebraic_lte
 

Detailed Description

Additional parameters that can be passed to the TimeStepper class.

Definition at line 44 of file petsc_ts.h.

Member Typedef Documentation

◆ real_type

Type that holds real-valued numbers.

Used to represent time and norms tolerances.

Definition at line 52 of file petsc_ts.h.

Member Function Documentation

◆ add_parameters()

void PETScWrappers::TimeStepperData::add_parameters ( ParameterHandler prm)

Import parameter values.

Member Data Documentation

◆ options_prefix

std::string PETScWrappers::TimeStepperData::options_prefix

Options database prefix.

Definition at line 127 of file petsc_ts.h.

◆ ts_type

std::string PETScWrappers::TimeStepperData::ts_type

PETSc solver type.

Definition at line 132 of file petsc_ts.h.

◆ initial_time

real_type PETScWrappers::TimeStepperData::initial_time

Initial time for the DAE.

Definition at line 137 of file petsc_ts.h.

◆ final_time

real_type PETScWrappers::TimeStepperData::final_time

Final time.

Definition at line 142 of file petsc_ts.h.

◆ initial_step_size

real_type PETScWrappers::TimeStepperData::initial_step_size

Initial step size.

Note
Non-positive values are ignored.

Definition at line 149 of file petsc_ts.h.

◆ max_steps

int PETScWrappers::TimeStepperData::max_steps

Maximum number of steps to be taken.

Note
Negative values are ignored.

Definition at line 156 of file petsc_ts.h.

◆ match_step

bool PETScWrappers::TimeStepperData::match_step

Flag to indicate to stop exactly at the requested final time.

Definition at line 161 of file petsc_ts.h.

◆ ts_adapt_type

std::string PETScWrappers::TimeStepperData::ts_adapt_type

PETSc time step adaptor type.

Definition at line 166 of file petsc_ts.h.

◆ minimum_step_size

real_type PETScWrappers::TimeStepperData::minimum_step_size

Minimum allowed step size for adaptive time stepping.

Note
Non-positive values indicate to use PETSc's default.

Definition at line 173 of file petsc_ts.h.

◆ maximum_step_size

real_type PETScWrappers::TimeStepperData::maximum_step_size

Maximum allowed step size for adaptive time stepping.

Note
Non-positive values indicate to use PETSc's default.

Definition at line 180 of file petsc_ts.h.

◆ absolute_tolerance

real_type PETScWrappers::TimeStepperData::absolute_tolerance

Absolute error tolerance for adaptive time stepping.

Note
Negative values indicate to use PETSc's default.

Definition at line 187 of file petsc_ts.h.

◆ relative_tolerance

real_type PETScWrappers::TimeStepperData::relative_tolerance

Relative error tolerance for adaptive time stepping.

Note
Negative values indicate to use PETSc's default.

Definition at line 194 of file petsc_ts.h.

◆ ignore_algebraic_lte

bool PETScWrappers::TimeStepperData::ignore_algebraic_lte

Ignore algebraic terms for local truncation error.

Definition at line 199 of file petsc_ts.h.


The documentation for this class was generated from the following file: