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 95 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 109 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 114 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 119 of file solver_fire.h.

---

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

• include/deal.II/lac/solver_fire.h