Open Qmin: energyMinimizerAdam Class Reference

#include <energyMinimizerAdam.h>

Inheritance diagram for energyMinimizerAdam:

Collaboration diagram for energyMinimizerAdam:

[legend]

Public Member Functions
virtual void	initializeFromModel ()
	by default, set Ndof More...

void	minimize ()
	Minimize to either the force tolerance or the maximum number of iterations. More...

virtual void	performUpdate ()
	The "intergate equatios of motion just calls minimize. More...

void	setAdamParameters (scalar b1=0.9, scalar b2=0.99, scalar eps=0.00000001, scalar _dt=0.0001, scalar fc=1e-12)

scalar	getMaxForce ()
	Return the maximum force. More...

void	setForceCutoff (scalar fc)
	Set the force cutoff. More...

virtual void	integrateEquationOfMotion ()

virtual void	integrateEOMGPU ()

virtual void	integrateEOMCPU ()

virtual scalar	getClassSize ()

virtual void	Update (int timestep)
	The fundamental function that a controlling Simulation can call. More...

void	setSimulation (shared_ptr< basicSimulation > _sim)
	set the simulation More...

virtual void	setModel (shared_ptr< simpleModel > _model)
	virtual function to allow the model to be a derived class More...

void	setPeriod (int _p)
	set the period More...

void	setPhase (int _p)
	set the phase More...

virtual void	spatialSorting ()
	allow for spatial sorting to be called if necessary... More...

virtual void	setReproducible (bool rep)
	Allow for a reproducibility call to be made. More...

virtual void	setGPU (bool _useGPU=true)
	Enforce GPU operation. More...

int	getNdof ()
	Get the number of degrees of freedom of the equation of motion. More...

void	setNdof (int _n)
	Set the number of degrees of freedom of the equation of motion. More...

virtual void	setDeltaT (scalar dt)
	allow all updaters to potentially implement an internal time scale More...

virtual void	setNThreads (int n)
	allow for setting multiple threads More...

void	setMaximumIterations (int maxIt)
	Set the maximum number of iterations before terminating (or set to -1 to ignore) More...

int	getCurrentIterations ()

int	getMaxIterations ()

void	setCurrentIterations (int newIterations)

int	getNTotal ()
	communicate the number of non-object sites across ranks More...

Public Attributes
GPUArray< dVec >	displacement
	an array of displacements More...

shared_ptr< basicSimulation >	sim
	A pointer to the governing simulation. More...

shared_ptr< simpleModel >	model
	A pointer to a simpleModel that the updater acts on. More...

vector< scalar >	updaterData

int	iterations
	The number of iterations performed. More...

Protected Member Functions
void	adamStepCPU ()

void	adamStepGPU ()

Protected Attributes
scalar	beta1

scalar	beta2

scalar	beta1t

scalar	beta2t

scalar	epsilon

scalar	forceMax

scalar	forceCutoff
	The cutoff value of the maximum force. More...

scalar	alpha

GPUArray< dVec >	biasedMomentumEstimate

GPUArray< dVec >	biasedMomentumSquaredEstimate

GPUArray< dVec >	correctedMomentumEstimate

GPUArray< dVec >	correctedMomentumSquaredEstimate

int	nThreads =1
	number of threads to use More...

int	Period
	The period of the updater... the updater will work every Period timesteps. More...

int	Phase
	The phase of the updater... the updater will work every Period timesteps offset by a phase. More...

bool	useGPU
	whether the updater does its work on the GPU or not More...

bool	neverGPU
	whether the updater never does work on the GPU More...

int	Ndof
	some measure of the number of degrees of freedom the equations of motion might need to know about locally More...

int	nTotal
	the total number of non-object sites across all ranks More...

bool	reproducible
	whether the RNGs give reproducible results More...

scalar	deltaT
	The internal time step size. More...

int	maxIterations
	The maximum number of iterations allowed. More...

Member Function Documentation

◆ initializeFromModel()

void energyMinimizerAdam::initializeFromModel ( )

virtual

by default, set Ndof

Reimplemented from equationOfMotion.

References biasedMomentumEstimate, biasedMomentumSquaredEstimate, correctedMomentumEstimate, correctedMomentumSquaredEstimate, equationOfMotion::displacement, updater::iterations, make_dVec(), updater::model, updater::Ndof, and GPUArray< T >::resize().

Referenced by minimize().

◆ minimize()

void energyMinimizerAdam::minimize ( )

Minimize to either the force tolerance or the maximum number of iterations.

References adamStepCPU(), adamStepGPU(), forceCutoff, forceMax, initializeFromModel(), updater::iterations, updater::maxIterations, updater::model, updater::Ndof, updater::sim, and updater::useGPU.

Referenced by performUpdate().

◆ performUpdate()

virtual void energyMinimizerAdam::performUpdate ( )

inlinevirtual

The "intergate equatios of motion just calls minimize.

Reimplemented from equationOfMotion.

References minimize().

◆ setAdamParameters()

void energyMinimizerAdam::setAdamParameters	(	scalar	b1 = `0.9`,
		scalar	b2 = `0.99`,
		scalar	eps = `0.00000001`,
		scalar	_dt = `0.0001`,
		scalar	fc = `1e-12`
	)

inline

References beta1, beta1t, beta2, beta2t, updater::deltaT, epsilon, and setForceCutoff().

◆ getMaxForce()

scalar energyMinimizerAdam::getMaxForce ( )

inlinevirtual

Return the maximum force.

Reimplemented from updater.

References forceMax.

◆ setForceCutoff()

void energyMinimizerAdam::setForceCutoff ( scalar fc )

inline

Set the force cutoff.

References forceCutoff.

Referenced by setAdamParameters().

◆ adamStepCPU()

void energyMinimizerAdam::adamStepCPU ( )

protected

◆ adamStepGPU()

void energyMinimizerAdam::adamStepGPU ( )

protected

References beta1, beta1t, beta2, beta2t, biasedMomentumEstimate, biasedMomentumSquaredEstimate, correctedMomentumEstimate, correctedMomentumSquaredEstimate, ArrayHandle< T >::data, updater::deltaT, access_location::device, equationOfMotion::displacement, gpu_adam_step(), updater::model, updater::Ndof, access_mode::readwrite, and updater::sim.

Referenced by minimize().

◆ integrateEquationOfMotion()

virtual void equationOfMotion::integrateEquationOfMotion ( )

inlinevirtualinherited

References equationOfMotion::initializeFromModel(), equationOfMotion::integrateEOMCPU(), equationOfMotion::integrateEOMGPU(), updater::model, updater::Ndof, and updater::useGPU.

Referenced by energyMinimizerFIRE::minimize(), and equationOfMotion::performUpdate().

◆ integrateEOMGPU()

virtual void equationOfMotion::integrateEOMGPU ( )

inlinevirtualinherited

Reimplemented in velocityVerlet.

Referenced by equationOfMotion::integrateEquationOfMotion().

◆ integrateEOMCPU()

virtual void equationOfMotion::integrateEOMCPU ( )

inlinevirtualinherited

Reimplemented in velocityVerlet.

Referenced by equationOfMotion::integrateEquationOfMotion().

◆ getClassSize()

virtual scalar equationOfMotion::getClassSize ( )

inlinevirtualinherited

Reimplemented from updater.

Reimplemented in energyMinimizerFIRE, energyMinimizerLoLBFGS, and energyMinimizerGradientDescent.

References equationOfMotion::displacement, updater::getClassSize(), GPUArray< T >::getNumElements(), and scalar.

Referenced by energyMinimizerGradientDescent::getClassSize(), energyMinimizerLoLBFGS::getClassSize(), and energyMinimizerFIRE::getClassSize().

◆ Update()

virtual void updater::Update ( int timestep )

inlinevirtualinherited

The fundamental function that a controlling Simulation can call.

References updater::performUpdate(), updater::Period, and updater::Phase.

◆ setSimulation()

void updater::setSimulation ( shared_ptr< basicSimulation > _sim )

inlineinherited

set the simulation

References updater::sim.

◆ setModel()

virtual void updater::setModel ( shared_ptr< simpleModel > _model )

inlinevirtualinherited

virtual function to allow the model to be a derived class

References updater::initializeFromModel(), and updater::model.

Referenced by energyMinimizerFIRE::energyMinimizerFIRE(), energyMinimizerGradientDescent::energyMinimizerGradientDescent(), energyMinimizerLoLBFGS::energyMinimizerLoLBFGS(), and energyMinimizerNesterovAG::energyMinimizerNesterovAG().

◆ setPeriod()

void updater::setPeriod ( int _p )

inlineinherited

set the period

References updater::Period.

◆ setPhase()

void updater::setPhase ( int _p )

inlineinherited

set the phase

References updater::Phase.

◆ spatialSorting()

virtual void updater::spatialSorting ( )

inlinevirtualinherited

allow for spatial sorting to be called if necessary...

◆ setReproducible()

virtual void updater::setReproducible ( bool rep )

inlinevirtualinherited

Allow for a reproducibility call to be made.

References updater::reproducible.

◆ setGPU()

virtual void updater::setGPU ( bool _useGPU = true )

inlinevirtualinherited

Enforce GPU operation.

References updater::useGPU.

Referenced by energyMinimizerNesterovAG::initializeParameters(), energyMinimizerLoLBFGS::initializeParameters(), energyMinimizerGradientDescent::initializeParameters(), and energyMinimizerFIRE::initializeParameters().

◆ getNdof()

int updater::getNdof ( )

inlineinherited

Get the number of degrees of freedom of the equation of motion.

References updater::Ndof.

◆ setNdof()

void updater::setNdof ( int _n )

inlineinherited

Set the number of degrees of freedom of the equation of motion.

References updater::Ndof.

◆ setDeltaT()

virtual void updater::setDeltaT ( scalar dt )

inlinevirtualinherited

allow all updaters to potentially implement an internal time scale

Reimplemented in energyMinimizerFIRE.

References updater::deltaT.

Referenced by energyMinimizerGradientDescent::initializeParameters(), and energyMinimizerGradientDescent::setGradientDescentParameters().

◆ setNThreads()

virtual void updater::setNThreads ( int n )

inlinevirtualinherited

allow for setting multiple threads

References n, and updater::nThreads.

◆ setMaximumIterations()

void updater::setMaximumIterations ( int maxIt )

inlineinherited

Set the maximum number of iterations before terminating (or set to -1 to ignore)

References updater::maxIterations.

◆ getCurrentIterations()

int updater::getCurrentIterations ( )

inlineinherited

References updater::iterations.

◆ getMaxIterations()

int updater::getMaxIterations ( )

inlineinherited

References updater::maxIterations.

◆ setCurrentIterations()

void updater::setCurrentIterations ( int newIterations )

inlineinherited

References updater::iterations.

◆ getNTotal()

int updater::getNTotal ( )

inherited

communicate the number of non-object sites across ranks

References access_location::host, updater::model, updater::Ndof, updater::nTotal, access_mode::read, updater::sim, and updater::updaterData.

Member Data Documentation

◆ beta1

scalar energyMinimizerAdam::beta1

protected

Referenced by adamStepCPU(), adamStepGPU(), and setAdamParameters().

◆ beta2

scalar energyMinimizerAdam::beta2

protected

Referenced by adamStepCPU(), adamStepGPU(), and setAdamParameters().

◆ beta1t

scalar energyMinimizerAdam::beta1t

protected

Referenced by adamStepCPU(), adamStepGPU(), and setAdamParameters().

◆ beta2t

scalar energyMinimizerAdam::beta2t

protected

Referenced by adamStepCPU(), adamStepGPU(), and setAdamParameters().

◆ epsilon

scalar energyMinimizerAdam::epsilon

protected

Referenced by adamStepCPU(), and setAdamParameters().

◆ forceMax

scalar energyMinimizerAdam::forceMax

protected

Referenced by adamStepCPU(), getMaxForce(), and minimize().

◆ forceCutoff

scalar energyMinimizerAdam::forceCutoff

protected

The cutoff value of the maximum force.

Referenced by minimize(), and setForceCutoff().

◆ alpha

scalar energyMinimizerAdam::alpha

protected

◆ biasedMomentumEstimate

GPUArray<dVec> energyMinimizerAdam::biasedMomentumEstimate

protected

Referenced by adamStepCPU(), adamStepGPU(), and initializeFromModel().

◆ biasedMomentumSquaredEstimate

GPUArray<dVec> energyMinimizerAdam::biasedMomentumSquaredEstimate

protected

Referenced by adamStepCPU(), adamStepGPU(), and initializeFromModel().

◆ correctedMomentumEstimate

GPUArray<dVec> energyMinimizerAdam::correctedMomentumEstimate

protected

Referenced by adamStepCPU(), adamStepGPU(), and initializeFromModel().

◆ correctedMomentumSquaredEstimate

GPUArray<dVec> energyMinimizerAdam::correctedMomentumSquaredEstimate

protected

Referenced by adamStepCPU(), adamStepGPU(), and initializeFromModel().

◆ displacement

GPUArray<dVec> equationOfMotion::displacement

inherited

an array of displacements

Referenced by adamStepCPU(), adamStepGPU(), equationOfMotion::getClassSize(), initializeFromModel(), equationOfMotion::initializeFromModel(), energyMinimizerGradientDescent::initializeFromModel(), energyMinimizerFIRE::initializeFromModel(), velocityVerlet::integrateEOMCPU(), and velocityVerlet::integrateEOMGPU().

◆ sim

shared_ptr<basicSimulation> updater::sim

inherited

◆ model

shared_ptr<simpleModel> updater::model

inherited

A pointer to a simpleModel that the updater acts on.

Referenced by adamStepCPU(), adamStepGPU(), energyMinimizerFIRE::fireStepCPU(), energyMinimizerFIRE::fireStepGPU(), updater::getNTotal(), energyMinimizerGradientDescent::gradientDescentCPU(), energyMinimizerGradientDescent::gradientDescentGPU(), initializeFromModel(), energyMinimizerNesterovAG::initializeFromModel(), energyMinimizerLoLBFGS::initializeFromModel(), equationOfMotion::initializeFromModel(), energyMinimizerGradientDescent::initializeFromModel(), energyMinimizerFIRE::initializeFromModel(), updater::initializeFromModel(), velocityVerlet::integrateEOMCPU(), velocityVerlet::integrateEOMGPU(), equationOfMotion::integrateEquationOfMotion(), energyMinimizerLoLBFGS::lineSearchCPU(), energyMinimizerLoLBFGS::LoLBFGSStepCPU(), energyMinimizerLoLBFGS::LoLBFGSStepGPU(), minimize(), energyMinimizerNesterovAG::minimize(), energyMinimizerLoLBFGS::minimize(), energyMinimizerGradientDescent::minimize(), energyMinimizerFIRE::minimize(), energyMinimizerNesterovAG::nesterovStepCPU(), energyMinimizerNesterovAG::nesterovStepGPU(), and updater::setModel().

◆ updaterData

vector<scalar> updater::updaterData

inherited

Referenced by energyMinimizerFIRE::fireStepCPU(), energyMinimizerFIRE::fireStepGPU(), updater::getNTotal(), energyMinimizerGradientDescent::gradientDescentCPU(), energyMinimizerGradientDescent::gradientDescentGPU(), energyMinimizerGradientDescent::initializeParameters(), and energyMinimizerFIRE::initializeParameters().

◆ iterations

int updater::iterations

inherited

The number of iterations performed.

Referenced by energyMinimizerFIRE::fireStepCPU(), energyMinimizerFIRE::fireStepGPU(), updater::getCurrentIterations(), initializeFromModel(), energyMinimizerNesterovAG::initializeParameters(), energyMinimizerLoLBFGS::initializeParameters(), energyMinimizerGradientDescent::initializeParameters(), energyMinimizerFIRE::initializeParameters(), energyMinimizerLoLBFGS::LoLBFGSStepCPU(), energyMinimizerLoLBFGS::LoLBFGSStepGPU(), minimize(), energyMinimizerNesterovAG::minimize(), energyMinimizerLoLBFGS::minimize(), energyMinimizerGradientDescent::minimize(), energyMinimizerFIRE::minimize(), and updater::setCurrentIterations().

◆ nThreads

int updater::nThreads =1

protectedinherited

number of threads to use

Referenced by updater::setNThreads().

◆ Period

int updater::Period

protectedinherited

The period of the updater... the updater will work every Period timesteps.

Referenced by updater::setPeriod(), updater::Update(), and updater::updater().

◆ Phase

int updater::Phase

protectedinherited

The phase of the updater... the updater will work every Period timesteps offset by a phase.

Referenced by updater::setPhase(), updater::Update(), and updater::updater().

◆ useGPU

bool updater::useGPU

protectedinherited

whether the updater does its work on the GPU or not

Referenced by energyMinimizerFIRE::fireStep(), energyMinimizerGradientDescent::gradientDescentStep(), equationOfMotion::integrateEquationOfMotion(), minimize(), energyMinimizerNesterovAG::minimize(), energyMinimizerLoLBFGS::minimize(), updater::setGPU(), and updater::updater().

◆ neverGPU

bool updater::neverGPU

protectedinherited

whether the updater never does work on the GPU

Referenced by equationOfMotion::initializeFromModel(), energyMinimizerGradientDescent::initializeFromModel(), and energyMinimizerFIRE::initializeFromModel().

◆ Ndof

int updater::Ndof

protectedinherited

some measure of the number of degrees of freedom the equations of motion might need to know about locally

Referenced by adamStepCPU(), adamStepGPU(), energyMinimizerFIRE::fireStepCPU(), energyMinimizerFIRE::fireStepGPU(), updater::getNdof(), updater::getNTotal(), energyMinimizerGradientDescent::gradientDescentCPU(), energyMinimizerGradientDescent::gradientDescentGPU(), initializeFromModel(), energyMinimizerNesterovAG::initializeFromModel(), energyMinimizerLoLBFGS::initializeFromModel(), equationOfMotion::initializeFromModel(), energyMinimizerGradientDescent::initializeFromModel(), energyMinimizerFIRE::initializeFromModel(), updater::initializeFromModel(), energyMinimizerFIRE::initializeParameters(), velocityVerlet::integrateEOMCPU(), velocityVerlet::integrateEOMGPU(), equationOfMotion::integrateEquationOfMotion(), energyMinimizerLoLBFGS::lineSearchCPU(), energyMinimizerLoLBFGS::LoLBFGSStepCPU(), energyMinimizerLoLBFGS::LoLBFGSStepGPU(), minimize(), energyMinimizerNesterovAG::minimize(), energyMinimizerLoLBFGS::minimize(), energyMinimizerGradientDescent::minimize(), energyMinimizerFIRE::minimize(), energyMinimizerNesterovAG::nesterovStepCPU(), energyMinimizerNesterovAG::nesterovStepGPU(), and updater::setNdof().

◆ nTotal

int updater::nTotal

protectedinherited

the total number of non-object sites across all ranks

◆ reproducible

bool updater::reproducible

protectedinherited

whether the RNGs give reproducible results

Referenced by updater::setReproducible(), and updater::updater().

◆ deltaT

scalar updater::deltaT

protectedinherited

The internal time step size.

Referenced by adamStepCPU(), adamStepGPU(), energyMinimizerFIRE::fireStepCPU(), energyMinimizerFIRE::fireStepGPU(), energyMinimizerGradientDescent::gradientDescentCPU(), energyMinimizerGradientDescent::gradientDescentGPU(), velocityVerlet::integrateEOMCPU(), velocityVerlet::integrateEOMGPU(), energyMinimizerLoLBFGS::minimize(), energyMinimizerFIRE::minimize(), energyMinimizerNesterovAG::nesterovStepCPU(), energyMinimizerNesterovAG::nesterovStepGPU(), setAdamParameters(), energyMinimizerFIRE::setDeltaT(), updater::setDeltaT(), energyMinimizerFIRE::setFIREParameters(), energyMinimizerGradientDescent::setGradientDescentParameters(), energyMinimizerLoLBFGS::setLoLBFGSParameters(), and energyMinimizerNesterovAG::setNesterovAGParameters().

◆ maxIterations

int updater::maxIterations

protectedinherited

The maximum number of iterations allowed.

Referenced by updater::getMaxIterations(), minimize(), energyMinimizerNesterovAG::minimize(), energyMinimizerLoLBFGS::minimize(), and updater::setMaximumIterations().

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ initializeFromModel()

◆ minimize()

◆ performUpdate()

◆ setAdamParameters()

◆ getMaxForce()

◆ setForceCutoff()

◆ adamStepCPU()

◆ adamStepGPU()

◆ integrateEquationOfMotion()

◆ integrateEOMGPU()

◆ integrateEOMCPU()

◆ getClassSize()

◆ Update()

◆ setSimulation()

◆ setModel()

◆ setPeriod()

◆ setPhase()

◆ spatialSorting()

◆ setReproducible()

◆ setGPU()

◆ getNdof()

◆ setNdof()

◆ setDeltaT()

◆ setNThreads()

◆ setMaximumIterations()

◆ getCurrentIterations()

◆ getMaxIterations()

◆ setCurrentIterations()

◆ getNTotal()

Member Data Documentation

◆ beta1

◆ beta2

◆ beta1t

◆ beta2t

◆ epsilon

◆ forceMax

◆ forceCutoff

◆ alpha

◆ biasedMomentumEstimate

◆ biasedMomentumSquaredEstimate

◆ correctedMomentumEstimate

◆ correctedMomentumSquaredEstimate

◆ displacement

◆ sim

◆ model

◆ updaterData

◆ iterations

◆ nThreads

◆ Period

◆ Phase

◆ useGPU

◆ neverGPU

◆ Ndof

◆ nTotal

◆ reproducible

◆ deltaT

◆ maxIterations