kynema::StepParameters Struct Reference

A Struct containing the paramters used to control the time stepping process. More...

#include <step_parameters.hpp>

Public Member Functions
	StepParameters (bool is_dynamic_solve_, size_t max_iter_, double h_, double rho_inf, double a_tol=1e-5, double r_tol=1e-3)
	Constructor for the StepParameters object.

Public Attributes
bool	is_dynamic_solve
size_t	max_iter
double	h
double	alpha_m
double	alpha_f
double	gamma
double	beta
double	gamma_prime
double	beta_prime
double	conditioner
double	absolute_convergence_tol
double	relative_convergence_tol

Detailed Description

A Struct containing the paramters used to control the time stepping process.

These paramteres

Constructor & Destructor Documentation

StepParameters()

kynema::StepParameters::StepParameters ( bool  is_dynamic_solve_, size_t  max_iter_, double  h_, double  rho_inf, double  a_tol = 1e-5, double  r_tol = 1e-3  )

inline

Constructor for the StepParameters object.

Parameters

is_dynamic_solve_	if a dynamic solve is to be performed (versus static)
max_iter_	the maximum number of nonlinear iterations to be performed
h_	the time step size
rho_inf	the numerical damping pactor, used to set the generalized alpha solver parameters
a_tol	the absolute error convergence tolerance
r_tol	the relative error convergence tolerance

Member Data Documentation

absolute_convergence_tol

double kynema::StepParameters::absolute_convergence_tol

alpha_f

double kynema::StepParameters::alpha_f

alpha_m

double kynema::StepParameters::alpha_m

beta

double kynema::StepParameters::beta

beta_prime

double kynema::StepParameters::beta_prime

conditioner

double kynema::StepParameters::conditioner

gamma

double kynema::StepParameters::gamma

gamma_prime

double kynema::StepParameters::gamma_prime

h

double kynema::StepParameters::h

is_dynamic_solve

bool kynema::StepParameters::is_dynamic_solve

max_iter

size_t kynema::StepParameters::max_iter

relative_convergence_tol

double kynema::StepParameters::relative_convergence_tol

---

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

• /home/runner/work/kynema/kynema/kynema/src/step/step_parameters.hpp