ForceBalance API  1.3
Automated optimization of force fields and empirical potentials
List of all members | Public Member Functions | Public Attributes
src.leastsq.LeastSquares Class Reference

Subclass of Target for general least squares fitting. More...

Inheritance diagram for src.leastsq.LeastSquares:
[legend]
Collaboration diagram for src.leastsq.LeastSquares:
[legend]

Public Member Functions

def __init__ (self, options, tgt_opts, forcefield)
 
def indicate (self)
 
def get (self, mvals, AGrad=False, AHess=False)
 LPW 05-30-2012. More...
 

Public Attributes

 MAQ
 Dictionary for derivative terms. More...
 
 D
 
 objective
 

Detailed Description

Subclass of Target for general least squares fitting.

Definition at line 36 of file leastsq.py.

Constructor & Destructor Documentation

◆ __init__()

def src.leastsq.LeastSquares.__init__ (   self,
  options,
  tgt_opts,
  forcefield 
)

Definition at line 39 of file leastsq.py.

Member Function Documentation

◆ get()

def src.leastsq.LeastSquares.get (   self,
  mvals,
  AGrad = False,
  AHess = False 
)

LPW 05-30-2012.

This subroutine builds the objective function (and optionally its derivatives) from a general software.

This subroutine interfaces with simulation software 'drivers'. The driver is expected to give exact values, fitting values, and weights.

Parameters
[in]mvalsMathematical parameter values
[in]AGradSwitch to turn on analytic gradient
[in]AHessSwitch to turn on analytic Hessian
Returns
Answer Contribution to the objective function

Definition at line 63 of file leastsq.py.

Here is the call graph for this function:

◆ indicate()

def src.leastsq.LeastSquares.indicate (   self)

Definition at line 42 of file leastsq.py.

Member Data Documentation

◆ D

src.leastsq.LeastSquares.D

Definition at line 127 of file leastsq.py.

◆ MAQ

src.leastsq.LeastSquares.MAQ

Dictionary for derivative terms.

Definition at line 89 of file leastsq.py.

◆ objective

src.leastsq.LeastSquares.objective

Definition at line 128 of file leastsq.py.


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