sNOsh Struct Reference
[NOsh class]

Class for parsing fixed format input files. More...

#include <nosh.h>

Collaboration diagram for sNOsh:
Collaboration graph
[legend]

Data Fields

NOsh_calccalc [NOSH_MAXCALC]
int ncalc
NOsh_calcelec [NOSH_MAXCALC]
int nelec
NOsh_calcapol [NOSH_MAXCALC]
int napol
int ispara
int proc_rank
int proc_size
int bogus
int elec2calc [NOSH_MAXCALC]
int apol2calc [NOSH_MAXCALC]
int nmol
char molpath [NOSH_MAXMOL][VMAX_ARGLEN]
NOsh_MolFormat molfmt [NOSH_MAXMOL]
Valistalist [NOSH_MAXMOL]
int gotparm
char parmpath [VMAX_ARGLEN]
NOsh_ParmFormat parmfmt
int ndiel
char dielXpath [NOSH_MAXMOL][VMAX_ARGLEN]
char dielYpath [NOSH_MAXMOL][VMAX_ARGLEN]
char dielZpath [NOSH_MAXMOL][VMAX_ARGLEN]
Vdata_Format dielfmt [NOSH_MAXMOL]
int nkappa
char kappapath [NOSH_MAXMOL][VMAX_ARGLEN]
Vdata_Format kappafmt [NOSH_MAXMOL]
int ncharge
char chargepath [NOSH_MAXMOL][VMAX_ARGLEN]
Vdata_Format chargefmt [NOSH_MAXMOL]
int nmesh
char meshpath [NOSH_MAXMOL][VMAX_ARGLEN]
Vdata_Format meshfmt [NOSH_MAXMOL]
int nprint
NOsh_PrintType printwhat [NOSH_MAXPRINT]
int printnarg [NOSH_MAXPRINT]
int printcalc [NOSH_MAXPRINT][NOSH_MAXPOP]
int printop [NOSH_MAXPRINT][NOSH_MAXPOP]
int parsed
char elecname [NOSH_MAXCALC][VMAX_ARGLEN]
char apolname [NOSH_MAXCALC][VMAX_ARGLEN]

Detailed Description

Class for parsing fixed format input files.

Author:
Nathan Baker

Field Documentation

Valist* sNOsh::alist[NOSH_MAXMOL]

Molecules for calculation (can be used in setting mesh centers

Referenced by NOsh_ctor2(), NOsh_setupApolCalc(), and NOsh_setupElecCalc().

NOsh_calc* sNOsh::apol[NOSH_MAXCALC]

The array of calculation objects corresponding to APOLAR statements read in the input file. Compare to sNOsh::calc

Referenced by NOsh_ctor2(), NOsh_dtor2(), and NOsh_setupApolCalc().

int sNOsh::apol2calc[NOSH_MAXCALC]
char sNOsh::apolname[NOSH_MAXCALC][VMAX_ARGLEN]

Optional user-specified name for APOLAR statement

Referenced by main(), printApolEnergy(), and printApolForce().

A flag which tells routines using NOsh that this particular NOsh is broken -- useful for parallel focusing calculations where the user gave us too many processors (1 => ignore this NOsh; 0 => this NOsh is OK)

Referenced by energyFE(), energyMG(), forceMG(), printFEPARM(), setPartMG(), solveMG(), writedataFE(), writedataFlat(), writedataMG(), writedataXML(), and writematMG().

NOsh_calc* sNOsh::calc[NOSH_MAXCALC]

The array of calculation objects corresponding to actual calculations performed by the code. Compare to sNOsh::elec

Referenced by energyFE(), energyMG(), main(), NOsh_ctor2(), NOsh_dtor2(), NOsh_getCalc(), printApolEnergy(), printApolForce(), printElecEnergy(), printElecForce(), printEnergy(), printForce(), returnEnergy(), writedataFlat(), and writedataXML().

Charge maps fileformats

Referenced by loadChargeMaps(), and NOsh_getChargefmt().

char sNOsh::chargepath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to charge map files

Referenced by loadChargeMaps(), and NOsh_getChargepath().

Dielectric maps file formats

Referenced by loadDielMaps(), and NOsh_getDielfmt().

char sNOsh::dielXpath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to x-shifted dielectric map files

Referenced by loadDielMaps(), and NOsh_getDielXpath().

char sNOsh::dielYpath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to y-shifted dielectric map files

Referenced by loadDielMaps(), and NOsh_getDielYpath().

char sNOsh::dielZpath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to z-shifted dielectric map files

Referenced by loadDielMaps(), and NOsh_getDielZpath().

NOsh_calc* sNOsh::elec[NOSH_MAXCALC]

The array of calculation objects corresponding to ELEC statements read in the input file. Compare to sNOsh::calc

Referenced by NOsh_ctor2(), NOsh_dtor2(), and NOsh_setupElecCalc().

int sNOsh::elec2calc[NOSH_MAXCALC]

A mapping between ELEC statements which appear in the input file and calc objects stored above. Since we allow both normal and focused multigrid, there isn't a 1-to-1 correspondence between ELEC statements and actual calcualtions. This can really confuse operations which work on specific calculations further down the road (like PRINT). Therefore this array is the initial point of entry for any calculation-specific operation. It points to a specific entry in the calc array.

Referenced by main(), NOsh_elec2calc(), NOsh_setupElecCalc(), printElecEnergy(), printElecForce(), printEnergy(), printForce(), returnEnergy(), writedataFlat(), and writedataXML().

char sNOsh::elecname[NOSH_MAXCALC][VMAX_ARGLEN]

Optional user-specified name for ELEC statement

Referenced by main(), NOsh_elecname(), printElecEnergy(), printElecForce(), printEnergy(), printForce(), writedataFlat(), and writedataXML().

Either have (1) or don't have (0) parm

Referenced by loadMolecules(), loadParameter(), and NOsh_ctor2().

1 => is a parallel calculation, 0 => is not

Referenced by NOsh_ctor2(), writedataFE(), writedataMG(), and writematMG().

Kappa maps file formats

Referenced by loadChargeMaps(), loadKappaMaps(), and NOsh_getKappafmt().

char sNOsh::kappapath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to kappa map files

Referenced by loadKappaMaps(), and NOsh_getKappapath().

Mesh fileformats

char sNOsh::meshpath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to mesh files

Mol files formats

Referenced by loadMolecules().

char sNOsh::molpath[NOSH_MAXMOL][VMAX_ARGLEN]

Paths to mol files

Referenced by loadMolecules(), and NOsh_getMolpath().

The number of apolar statements in the input file and in the apolar array

Referenced by main(), NOsh_ctor2(), NOsh_dtor2(), and NOsh_setupApolCalc().

The number of calculations in the calc array

Referenced by killFE(), killForce(), killMG(), main(), NOsh_ctor2(), NOsh_dtor2(), NOsh_setupApolCalc(), and NOsh_setupElecCalc().

Number of dielectric maps

Referenced by initMG(), killDielMaps(), loadDielMaps(), NOsh_ctor2(), NOsh_parseInput(), and NOsh_setupElecCalc().

The number of elec statements in the input file and in the elec array

Referenced by main(), NOsh_ctor2(), NOsh_dtor2(), NOsh_parseInput(), NOsh_setupElecCalc(), writedataFlat(), and writedataXML().

Number of meshes

Referenced by killFE().

How many print sections?

Referenced by main(), NOsh_ctor2(), writedataFlat(), and writedataXML().

Parm file format

Referenced by loadParameter().

char sNOsh::parmpath[VMAX_ARGLEN]

Paths to parm file

Referenced by loadMolecules(), and loadParameter().

Have we parsed an input file yet?

Referenced by NOsh_ctor2(), and NOsh_parseInput().

int sNOsh::printcalc[NOSH_MAXPRINT][NOSH_MAXPOP]
int sNOsh::printnarg[NOSH_MAXPRINT]
int sNOsh::printop[NOSH_MAXPRINT][NOSH_MAXPOP]

What do we print:

  • 0 = energy,
  • 1 = force

Referenced by main(), NOsh_printWhat(), writedataFlat(), and writedataXML().

Processor rank in parallel calculation

Referenced by NOsh_ctor2(), writedataFE(), writedataMG(), and writematMG().

Number of processors in parallel calculation

Referenced by NOsh_ctor2().


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

Generated by  doxygen 1.6.2