steepest_descent.hpp File Reference

#include "ParticleRange.hpp"

Include dependency graph for steepest_descent.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SteepestDescentParameters
	Parameters for the steepest descent algorithm. More...

Functions
void	register_integrator (SteepestDescentParameters const &obj)
bool	steepest_descent_step (const ParticleRange &particles)
	Steepest descent integrator.

Function Documentation

register_integrator()

void register_integrator

(

SteepestDescentParameters const &

obj

)

Definition at line 104 of file steepest_descent.cpp.

References params, and stream.

Referenced by ScriptInterface::Integrators::SteepestDescent::activate(), and ScriptInterface::Integrators::StokesianDynamics::activate().

steepest_descent_step()

bool steepest_descent_step

(

const ParticleRange &

particles

)

Steepest descent integrator.

Returns

whether the maximum force/torque encountered is below the user limit f_max.

Definition at line 46 of file steepest_descent.cpp.

References System::System::cell_structure, comm_cart, SteepestDescentParameters::f_max, SteepestDescentParameters::gamma, System::get_system(), local_rotate_particle(), SteepestDescentParameters::max_displacement, params, Cells::RESORT_LOCAL, Utils::sqr(), and stream.

Referenced by integrator_step_1().