SteepestDescentParameters Struct Reference

Parameters for the steepest descent algorithm. More...

#include <steepest_descent.hpp>

Public Member Functions
	SteepestDescentParameters (double f_max, double gamma, double max_displacement)

Public Attributes
double	f_max
	Maximal particle force.
double	gamma
	Dampening constant.
double	max_displacement
	Maximal particle displacement.

Detailed Description

Parameters for the steepest descent algorithm.

Definition at line 28 of file steepest_descent.hpp.

Constructor & Destructor Documentation

SteepestDescentParameters()

SteepestDescentParameters::SteepestDescentParameters	(	double	f_max,
		double	gamma,
		double	max_displacement
	)

Definition at line 108 of file steepest_descent.cpp.

References f_max, gamma, and max_displacement.

Member Data Documentation

f_max

double SteepestDescentParameters::f_max

Maximal particle force.

If the maximal force experienced by particles in the system (in any direction) is inferior to this threshold, minimization stops.

Definition at line 34 of file steepest_descent.hpp.

Referenced by steepest_descent_step(), ScriptInterface::Integrators::SteepestDescent::SteepestDescent(), and SteepestDescentParameters().

gamma

double SteepestDescentParameters::gamma

Dampening constant.

Definition at line 36 of file steepest_descent.hpp.

Referenced by dpd_pair_force(), steepest_descent_step(), ScriptInterface::Integrators::SteepestDescent::SteepestDescent(), and SteepestDescentParameters().

max_displacement

double SteepestDescentParameters::max_displacement

Maximal particle displacement.

Maximal distance that a particle can travel during one integration step, in one direction.

Definition at line 42 of file steepest_descent.hpp.

Referenced by steepest_descent_step(), ScriptInterface::Integrators::SteepestDescent::SteepestDescent(), and SteepestDescentParameters().

---

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

• steepest_descent.hpp
• steepest_descent.cpp