Files | |
| file | routines.h |
| Header file for front end auxiliary routines. | |
Data Structures | |
| struct | AtomForce |
| Structure to hold atomic forces. More... | |
Defines | |
| #define | APBSRC 13 |
| Return code for APBS during failure. | |
Typedefs | |
| typedef AtomForce | AtomForce |
| Define AtomForce type. | |
Functions | |
| VPUBLIC Vparam * | loadParameter (NOsh *nosh) |
| Loads and returns parameter object. | |
| VPUBLIC int | loadMolecules (NOsh *nosh, Vparam *param, Valist *alist[NOSH_MAXMOL]) |
| Load the molecules given in NOsh into atom lists. | |
| VPUBLIC void | killMolecules (NOsh *nosh, Valist *alist[NOSH_MAXMOL]) |
| Destroy the loaded molecules. | |
| VPUBLIC int | loadDielMaps (NOsh *nosh, Vgrid *dielXMap[NOSH_MAXMOL], Vgrid *dielYMap[NOSH_MAXMOL], Vgrid *dielZMap[NOSH_MAXMOL]) |
| Load the dielectric maps given in NOsh into grid objects. | |
| VPUBLIC void | killDielMaps (NOsh *nosh, Vgrid *dielXMap[NOSH_MAXMOL], Vgrid *dielYMap[NOSH_MAXMOL], Vgrid *dielZMap[NOSH_MAXMOL]) |
| Destroy the loaded dielectric. | |
| VPUBLIC int | loadKappaMaps (NOsh *nosh, Vgrid *map[NOSH_MAXMOL]) |
| Load the kappa maps given in NOsh into grid objects. | |
| VPUBLIC void | killKappaMaps (NOsh *nosh, Vgrid *map[NOSH_MAXMOL]) |
| Destroy the loaded kappa maps. | |
| VPUBLIC int | loadChargeMaps (NOsh *nosh, Vgrid *map[NOSH_MAXMOL]) |
| Load the charge maps given in NOsh into grid objects. | |
| VPUBLIC void | killChargeMaps (NOsh *nosh, Vgrid *map[NOSH_MAXMOL]) |
| Destroy the loaded charge maps. | |
| VPUBLIC void | printPBEPARM (PBEparm *pbeparm) |
| Print out generic PBE params loaded from input. | |
| VPUBLIC void | printMGPARM (MGparm *mgparm, double realCenter[3]) |
| Print out MG-specific params loaded from input. | |
| VPUBLIC int | initMG (int icalc, NOsh *nosh, MGparm *mgparm, PBEparm *pbeparm, double realCenter[3], Vpbe *pbe[NOSH_MAXCALC], Valist *alist[NOSH_MAXMOL], Vgrid *dielXMap[NOSH_MAXMOL], Vgrid *dielYMap[NOSH_MAXMOL], Vgrid *dielZMap[NOSH_MAXMOL], Vgrid *kappaMap[NOSH_MAXMOL], Vgrid *chargeMap[NOSH_MAXMOL], Vpmgp *pmgp[NOSH_MAXCALC], Vpmg *pmg[NOSH_MAXCALC]) |
| Initialize an MG calculation. | |
| VPUBLIC void | killMG (NOsh *nosh, Vpbe *pbe[NOSH_MAXCALC], Vpmgp *pmgp[NOSH_MAXCALC], Vpmg *pmg[NOSH_MAXCALC]) |
| Kill structures initialized during an MG calculation. | |
| VPUBLIC int | solveMG (NOsh *nosh, Vpmg *pmg, MGparm_CalcType type) |
| Solve the PBE with MG. | |
| VPUBLIC int | setPartMG (NOsh *nosh, MGparm *mgparm, Vpmg *pmg) |
| Set MG partitions for calculating observables and performing I/O. | |
| VPUBLIC int | energyMG (NOsh *nosh, int icalc, Vpmg *pmg, int *nenergy, double *totEnergy, double *qfEnergy, double *qmEnergy, double *dielEnergy) |
| Calculate electrostatic energies from MG solution. | |
| VPUBLIC void | killEnergy () |
| Kill arrays allocated for energies. | |
| VPUBLIC int | forceMG (Vmem *mem, NOsh *nosh, PBEparm *pbeparm, MGparm *mgparm, Vpmg *pmg, int *nforce, AtomForce **atomForce, Valist *alist[NOSH_MAXMOL]) |
| Calculate forces from MG solution. | |
| VPUBLIC void | killForce (Vmem *mem, NOsh *nosh, int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC]) |
| Free memory from MG force calculation. | |
| VPUBLIC void | storeAtomEnergy (Vpmg *pmg, int icalc, double **atomEnergy, int *nenergy) |
| Store energy in arrays for future use. | |
| VPUBLIC int | writedataFlat (NOsh *nosh, Vcom *com, const char *fname, double totEnergy[NOSH_MAXCALC], double qfEnergy[NOSH_MAXCALC], double qmEnergy[NOSH_MAXCALC], double dielEnergy[NOSH_MAXCALC], int nenergy[NOSH_MAXCALC], double *atomEnergy[NOSH_MAXCALC], int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC]) |
| Write out information to a flat file. | |
| VPUBLIC int | writedataXML (NOsh *nosh, Vcom *com, const char *fname, double totEnergy[NOSH_MAXCALC], double qfEnergy[NOSH_MAXCALC], double qmEnergy[NOSH_MAXCALC], double dielEnergy[NOSH_MAXCALC], int nenergy[NOSH_MAXCALC], double *atomEnergy[NOSH_MAXCALC], int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC]) |
| Write out information to an XML file. | |
| VPUBLIC int | writedataMG (int rank, NOsh *nosh, PBEparm *pbeparm, Vpmg *pmg) |
| Write out observables from MG calculation to file. | |
| VPUBLIC int | writematMG (int rank, NOsh *nosh, PBEparm *pbeparm, Vpmg *pmg) |
| Write out operator matrix from MG calculation to file. | |
| VPUBLIC double | returnEnergy (Vcom *com, NOsh *nosh, double totEnergy[NOSH_MAXCALC], int iprint) |
| Access net local energy. | |
| VPUBLIC int | printEnergy (Vcom *com, NOsh *nosh, double totEnergy[NOSH_MAXCALC], int iprint) |
| Combine and pretty-print energy data (deprecated...see printElecEnergy). | |
| VPUBLIC int | printElecEnergy (Vcom *com, NOsh *nosh, double totEnergy[NOSH_MAXCALC], int iprint) |
| Combine and pretty-print energy data. | |
| VPUBLIC int | printApolEnergy (NOsh *nosh, int iprint) |
| Combine and pretty-print energy data. | |
| VPUBLIC int | printForce (Vcom *com, NOsh *nosh, int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC], int iprint) |
| Combine and pretty-print force data (deprecated...see printElecForce). | |
| VPUBLIC int | printElecForce (Vcom *com, NOsh *nosh, int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC], int iprint) |
| Combine and pretty-print force data. | |
| VPUBLIC int | printApolForce (Vcom *com, NOsh *nosh, int nforce[NOSH_MAXCALC], AtomForce *atomForce[NOSH_MAXCALC], int iprint) |
| Combine and pretty-print force data. | |
| VPUBLIC void | startVio () |
| Wrapper to start MALOC Vio layer. | |
| VPUBLIC void | printFEPARM (int icalc, NOsh *nosh, FEMparm *feparm, Vfetk *fetk[NOSH_MAXCALC]) |
| Print out FE-specific params loaded from input. | |
| VPUBLIC int | energyFE (NOsh *nosh, int icalc, Vfetk *fetk[NOSH_MAXCALC], int *nenergy, double *totEnergy, double *qfEnergy, double *qmEnergy, double *dielEnergy) |
| Calculate electrostatic energies from FE solution. | |
| Vrc_Codes | initFE (int icalc, NOsh *nosh, FEMparm *feparm, PBEparm *pbeparm, Vpbe *pbe[NOSH_MAXCALC], Valist *alist[NOSH_MAXMOL], Vfetk *fetk[NOSH_MAXCALC], Gem *gm[NOSH_MAXCALC]) |
| Initialize FE solver objects. | |
| VPUBLIC void | killFE (NOsh *nosh, Vpbe *pbe[NOSH_MAXCALC], Vfetk *fetk[NOSH_MAXCALC], Gem *gm[NOSH_MAXMOL]) |
| Kill structures initialized during an FE calculation. | |
| VPUBLIC int | preRefineFE (int icalc, NOsh *nosh, FEMparm *feparm, Vfetk *fetk[NOSH_MAXCALC]) |
| Pre-refine mesh before solve. | |
| VPUBLIC int | partFE (int icalc, NOsh *nosh, FEMparm *feparm, Vfetk *fetk[NOSH_MAXCALC]) |
| Partition mesh (if applicable). | |
| VPUBLIC int | solveFE (int icalc, NOsh *nosh, PBEparm *pbeparm, FEMparm *feparm, Vfetk *fetk[NOSH_MAXCALC]) |
| Solve-estimate-refine. | |
| VPUBLIC int | postRefineFE (int icalc, NOsh *nosh, FEMparm *feparm, Vfetk *fetk[NOSH_MAXCALC]) |
| Estimate error, mark mesh, and refine mesh after solve. | |
| VPUBLIC int | writedataFE (int rank, NOsh *nosh, PBEparm *pbeparm, Vfetk *fetk) |
| Write FEM data to files. | |
| VPUBLIC int | energyAPOL (APOLparm *apolparm, double sasa, double sav, double atomsasa[], double atomwcaEnergy[], int numatoms) |
| Calculate non-polar energies. | |
| VPUBLIC int | forceAPOL (Vacc *acc, Vmem *mem, APOLparm *apolparm, int *nforce, AtomForce **atomForce, Valist *alist, Vclist *clist) |
| Calculate non-polar forces. | |
| VPUBLIC int | initAPOL (NOsh *nosh, Vmem *mem, Vparam *param, APOLparm *apolparm, int *nforce, AtomForce **atomForce, Valist *alist) |
| Upperlevel routine to the non-polar energy and force routines. | |
| Vrc_Codes | loadMeshes (NOsh *nosh, Gem *gm[NOSH_MAXMOL]) |
| Load the meshes given in NOsh into geometry objects. | |
| void | killMeshes (NOsh *nosh, Gem *alist[NOSH_MAXMOL]) |
| Destroy the loaded meshes. | |
|
||||||||||||||||||||||||||||
|
Calculate non-polar energies.
|
|
||||||||||||||||||||||||||||||||||||
|
Calculate electrostatic energies from FE solution.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||||||
|
Calculate electrostatic energies from MG solution.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||
|
Calculate non-polar forces.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||||||
|
Calculate forces from MG solution.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||
|
Upperlevel routine to the non-polar energy and force routines.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||||||
|
Initialize FE solver objects.
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Initialize an MG calculation.
|
Here is the call graph for this function:

|
||||||||||||
|
Destroy the loaded charge maps.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Destroy the loaded dielectric.
|
Here is the call graph for this function:

|
|
Kill arrays allocated for energies.
|
|
||||||||||||||||||||
|
Kill structures initialized during an FE calculation.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Free memory from MG force calculation.
|
|
||||||||||||
|
Destroy the loaded kappa maps.
|
Here is the call graph for this function:

|
||||||||||||
|
Destroy the loaded meshes.
|
|
||||||||||||||||||||
|
Kill structures initialized during an MG calculation.
|
Here is the call graph for this function:

|
||||||||||||
|
Destroy the loaded molecules.
|
Here is the call graph for this function:

|
||||||||||||
|
Load the charge maps given in NOsh into grid objects.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Load the dielectric maps given in NOsh into grid objects.
|
Here is the call graph for this function:

|
||||||||||||
|
Load the kappa maps given in NOsh into grid objects.
|
Here is the call graph for this function:

|
||||||||||||
|
Load the meshes given in NOsh into geometry objects.
|
|
||||||||||||||||
|
Load the molecules given in NOsh into atom lists.
|
Here is the call graph for this function:

|
|
Loads and returns parameter object.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Partition mesh (if applicable).
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Estimate error, mark mesh, and refine mesh after solve.
|
|
||||||||||||||||||||
|
Pre-refine mesh before solve.
|
|
||||||||||||
|
Combine and pretty-print energy data.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||
|
Combine and pretty-print force data.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Combine and pretty-print energy data.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||
|
Combine and pretty-print force data.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Combine and pretty-print energy data (deprecated...see printElecEnergy).
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Print out FE-specific params loaded from input.
|
|
||||||||||||||||||||||||
|
Combine and pretty-print force data (deprecated...see printElecForce).
|
Here is the call graph for this function:

|
||||||||||||
|
Print out MG-specific params loaded from input.
|
|
|
Print out generic PBE params loaded from input.
|
|
||||||||||||||||||||
|
Access net local energy.
|
|
||||||||||||||||
|
Set MG partitions for calculating observables and performing I/O.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||
|
Solve-estimate-refine. < AM_hPcg < Coarse-grid solver; 0 = SLU, 1 = MG, 2 = CG, 3 = BCG, 4 = PCG, 5 = PBCG < Primal problem < Preconditioner; 0 = identity. |
|
||||||||||||||||
|
Solve the PBE with MG.
|
Here is the call graph for this function:

|
|
Wrapper to start MALOC Vio layer.
|
|
||||||||||||||||||||
|
Store energy in arrays for future use.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Write FEM data to files.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Write out information to a flat file.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Write out observables from MG calculation to file.
|
Here is the call graph for this function:

|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Write out information to an XML file.
|
Here is the call graph for this function:

|
||||||||||||||||||||
|
Write out operator matrix from MG calculation to file.
|
Here is the call graph for this function:

1.3.4