Reference documentation for deal.II version 9.2.0
\(\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\}}\)
Public Member Functions | Public Attributes | List of all members
SolverFIRE< VectorType >::AdditionalData Struct Reference

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

Public Member Functions

 AdditionalData (const double initial_timestep=0.1, const double maximum_timestep=1, const double maximum_linfty_norm=1)
 

Public Attributes

const double initial_timestep
 
const double maximum_timestep
 
const double maximum_linfty_norm
 

Detailed Description

template<typename VectorType = Vector<double>>
struct SolverFIRE< VectorType >::AdditionalData

Standardized data struct to pipe additional data to the solver.

Definition at line 97 of file solver_fire.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename VectorType = Vector<double>>
SolverFIRE< VectorType >::AdditionalData::AdditionalData ( const double  initial_timestep = 0.1,
const double  maximum_timestep = 1,
const double  maximum_linfty_norm = 1 
)
explicit

Constructor. By default, set the initial time step for the (forward) Euler integration step to 0.1, the maximum time step to 1 and the maximum change allowed in any variable (per iteration) to 1.

Member Data Documentation

◆ initial_timestep

template<typename VectorType = Vector<double>>
const double SolverFIRE< VectorType >::AdditionalData::initial_timestep

Initial time step for the (forward) Euler integration step.

Definition at line 111 of file solver_fire.h.

◆ maximum_timestep

template<typename VectorType = Vector<double>>
const double SolverFIRE< VectorType >::AdditionalData::maximum_timestep

Maximum time step for the (forward) Euler integration step.

Definition at line 116 of file solver_fire.h.

◆ maximum_linfty_norm

template<typename VectorType = Vector<double>>
const double SolverFIRE< VectorType >::AdditionalData::maximum_linfty_norm

Maximum change allowed in any variable of the objective function.

Definition at line 121 of file solver_fire.h.


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