JDFTx  1.1.0
IonicMinimizer Class Reference
Inheritance diagram for IonicMinimizer:
Minimizable< IonicGradient >

Public Member Functions

 IonicMinimizer (Everything &e)
 
void step (const IonicGradient &dir, double alpha)
 Move the state in parameter space along direction dir with scale alpha.
 
double compute (IonicGradient *grad)
 Returns the objective function at the current state and store the gradient in grad, if non-null.
 
IonicGradient precondition (const IonicGradient &grad)
 
bool report (int iter)
 
void constrain (IonicGradient &)
 
double sync (double x) const
 All processes minimize together; make sure scalars are in sync to round-off error.
 
double minimize (const MinimizeParams &params)
 minor addition to Minimizable::minimize to invoke charge analysis at final positions
 
- Public Member Functions inherited from Minimizable< IonicGradient >
double minimize (const MinimizeParams &params)
 Minimize this objective function with algorithm controlled by params and return the minimized value.
 
void fdTest (const MinimizeParams &params)
 

Member Function Documentation

void IonicMinimizer::constrain ( IonicGradient )
virtual

Constrain an arbitrary vector to the space of free directions for minimize. Used only to generate a random direction for fdTest within the valid minimization subspace.

Reimplemented from Minimizable< IonicGradient >.

IonicGradient IonicMinimizer::precondition ( const IonicGradient grad)
virtual

Override to enable preconditioning: return the preconditioned gradient, given the gradient The last call to compute() is guaranteed to be at the same position, so a cached result may be returned

Reimplemented from Minimizable< IonicGradient >.

bool IonicMinimizer::report ( int  iter)
virtual

Override for optional processing/reporting after each/every few iterations It should return whether the state was modified

Reimplemented from Minimizable< IonicGradient >.


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