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

Subclass of Target for lipid property matching. More...

Inheritance diagram for src.lipid.Lipid:
[legend]
Collaboration diagram for src.lipid.Lipid:
[legend]

Public Member Functions

def __init__ (self, options, tgt_opts, forcefield)
 
def prepare_temp_directory (self)
 Prepare the temporary directory by copying in important files. More...
 
def read_data (self)
 
def check_files (self, there)
 
def npt_simulation (self, temperature, pressure, simnum)
 Submit a NPT simulation to the Work Queue. More...
 
def polarization_correction (self, mvals)
 
def indicate (self)
 
def objective_term (self, points, expname, calc, err, grad, name="Quantity", SubAverage=False)
 
def submit_jobs (self, mvals, AGrad=True, AHess=True)
 
def get (self, mvals, AGrad=True, AHess=True)
 Fitting of lipid bulk properties. More...
 

Public Attributes

 do_self_pol
 
 loop_over_snapshots
 LPW 2018-02-11: This is set to True if the target calculates a single-point property over several existing snapshots. More...
 
 last_traj
 
 extra_output
 
 lipid_mols
 
 lipid_mols_new
 
 lipid_mol
 
 gas_engine
 
 read_indicate
 
 write_indicate
 
 read_objective
 
 SavedMVal
 Saved force field mvals for all iterations. More...
 
 SavedTraj
 Saved trajectories for all iterations and all temperatures. More...
 
 MBarEnergy
 Evaluated energies for all trajectories (i.e. More...
 
 RefData
 
 PhasePoints
 
 Labels
 
 engname
 
 w_rho
 Density. More...
 
 w_alpha
 
 w_kappa
 
 w_cp
 
 w_eps0
 
 w_al
 
 w_scd
 
 w_lkappa
 
 Xp
 
 Wp
 
 Pp
 
 Gp
 
 Objective
 

Detailed Description

Subclass of Target for lipid property matching.

Definition at line 57 of file lipid.py.

Constructor & Destructor Documentation

◆ __init__()

def src.lipid.Lipid.__init__ (   self,
  options,
  tgt_opts,
  forcefield 
)

Definition at line 60 of file lipid.py.

Here is the call graph for this function:

Member Function Documentation

◆ check_files()

def src.lipid.Lipid.check_files (   self,
  there 
)

Definition at line 307 of file lipid.py.

◆ get()

def src.lipid.Lipid.get (   self,
  mvals,
  AGrad = True,
  AHess = True 
)

Fitting of lipid bulk properties.

This is the current major direction of development for ForceBalance. Basically, fitting the QM energies / forces alone does not always give us the best simulation behavior. In many cases it makes more sense to try and reproduce some experimentally known data as well.

In order to reproduce experimentally known data, we need to run a simulation and compare the simulation result to experiment. The main challenge here is that the simulations are computationally intensive (i.e. they require energy and force evaluations), and furthermore the results are noisy. We need to run the simulations automatically and remotely (i.e. on clusters) and a good way to calculate the derivatives of the simulation results with respect to the parameter values.

This function contains some experimentally known values of the density and enthalpy of vaporization (Hvap) of lipid water. It launches the density and Hvap calculations on the cluster, and gathers the results / derivatives. The actual calculation of results / derivatives is done in a separate file.

After the results come back, they are gathered together to form an objective function.

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 Fill in the weight matrix with MBAR weights where MBAR was run, and equal weights otherwise.

Definition at line 550 of file lipid.py.

Here is the call graph for this function:

◆ indicate()

def src.lipid.Lipid.indicate (   self)

Definition at line 353 of file lipid.py.

Here is the call graph for this function:

◆ npt_simulation()

def src.lipid.Lipid.npt_simulation (   self,
  temperature,
  pressure,
  simnum 
)

Submit a NPT simulation to the Work Queue.

Definition at line 321 of file lipid.py.

Here is the call graph for this function:

◆ objective_term()

def src.lipid.Lipid.objective_term (   self,
  points,
  expname,
  calc,
  err,
  grad,
  name = "Quantity",
  SubAverage = False 
)

Definition at line 381 of file lipid.py.

Here is the call graph for this function:

◆ polarization_correction()

def src.lipid.Lipid.polarization_correction (   self,
  mvals 
)

Definition at line 337 of file lipid.py.

Here is the call graph for this function:

◆ prepare_temp_directory()

def src.lipid.Lipid.prepare_temp_directory (   self)

Prepare the temporary directory by copying in important files.

Definition at line 189 of file lipid.py.

Here is the call graph for this function:

◆ read_data()

def src.lipid.Lipid.read_data (   self)

Definition at line 196 of file lipid.py.

◆ submit_jobs()

def src.lipid.Lipid.submit_jobs (   self,
  mvals,
  AGrad = True,
  AHess = True 
)

Definition at line 465 of file lipid.py.

Here is the call graph for this function:

Member Data Documentation

◆ do_self_pol

src.lipid.Lipid.do_self_pol

Definition at line 112 of file lipid.py.

◆ engname

src.lipid.Lipid.engname

Definition at line 326 of file lipid.py.

◆ extra_output

src.lipid.Lipid.extra_output

Definition at line 127 of file lipid.py.

◆ gas_engine

src.lipid.Lipid.gas_engine

Definition at line 168 of file lipid.py.

◆ Gp

src.lipid.Lipid.Gp

Definition at line 839 of file lipid.py.

◆ Labels

src.lipid.Lipid.Labels

Definition at line 297 of file lipid.py.

◆ last_traj

src.lipid.Lipid.last_traj

Definition at line 125 of file lipid.py.

◆ lipid_mol

src.lipid.Lipid.lipid_mol

Definition at line 155 of file lipid.py.

◆ lipid_mols

src.lipid.Lipid.lipid_mols

Definition at line 135 of file lipid.py.

◆ lipid_mols_new

src.lipid.Lipid.lipid_mols_new

Definition at line 136 of file lipid.py.

◆ loop_over_snapshots

src.lipid.Lipid.loop_over_snapshots

LPW 2018-02-11: This is set to True if the target calculates a single-point property over several existing snapshots.

Definition at line 123 of file lipid.py.

◆ MBarEnergy

src.lipid.Lipid.MBarEnergy

Evaluated energies for all trajectories (i.e.

all iterations and all temperatures), using all mvals

Definition at line 185 of file lipid.py.

◆ Objective

src.lipid.Lipid.Objective

Definition at line 841 of file lipid.py.

◆ PhasePoints

src.lipid.Lipid.PhasePoints

Definition at line 292 of file lipid.py.

◆ Pp

src.lipid.Lipid.Pp

Definition at line 836 of file lipid.py.

◆ read_indicate

src.lipid.Lipid.read_indicate

Definition at line 170 of file lipid.py.

◆ read_objective

src.lipid.Lipid.read_objective

Definition at line 173 of file lipid.py.

◆ RefData

src.lipid.Lipid.RefData

Definition at line 207 of file lipid.py.

◆ SavedMVal

src.lipid.Lipid.SavedMVal

Saved force field mvals for all iterations.

Definition at line 181 of file lipid.py.

◆ SavedTraj

src.lipid.Lipid.SavedTraj

Saved trajectories for all iterations and all temperatures.

Definition at line 183 of file lipid.py.

◆ w_al

src.lipid.Lipid.w_al

Definition at line 808 of file lipid.py.

◆ w_alpha

src.lipid.Lipid.w_alpha

Definition at line 804 of file lipid.py.

◆ w_cp

src.lipid.Lipid.w_cp

Definition at line 806 of file lipid.py.

◆ w_eps0

src.lipid.Lipid.w_eps0

Definition at line 807 of file lipid.py.

◆ w_kappa

src.lipid.Lipid.w_kappa

Definition at line 805 of file lipid.py.

◆ w_lkappa

src.lipid.Lipid.w_lkappa

Definition at line 810 of file lipid.py.

◆ w_rho

src.lipid.Lipid.w_rho

Density.

Ignore enthalpy. Thermal expansion coefficient. Isothermal compressibility. Isobaric heat capacity. Static dielectric constant. Average area per lipid Bilayer Isothermal compressibility. Deuterium order parameter Estimation of errors.

Definition at line 803 of file lipid.py.

◆ w_scd

src.lipid.Lipid.w_scd

Definition at line 809 of file lipid.py.

◆ Wp

src.lipid.Lipid.Wp

Definition at line 834 of file lipid.py.

◆ write_indicate

src.lipid.Lipid.write_indicate

Definition at line 171 of file lipid.py.

◆ Xp

src.lipid.Lipid.Xp

Definition at line 832 of file lipid.py.


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