IGMPlot: src/include/reader.h File Reference

IGMPlot 3.16 Optimized IGMplot version able to use wfn/wfx/xyz files

Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions | Variables
reader.h File Reference

Tool functions for reading input data. More...

`#include <Results.h>`
`#include <WFreader.h>`
Include dependency graph for reader.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Typedefs
typedef enum ATOM_TYPES | atom_types_t
| The atoms' types.

## Enumerations
enum | ATOM_TYPES
| The atoms' types.

## Functions
void | setFrag (const std::string definition, const param_types_t FRAG, const int nbAtoms)
| This function is used to ascribe FRAG atom indexes from string definition given in param.igm input file.
bool | isANumber (const std::string &s)
| This function is used to check whether a string is a number or not.
int | conversionAtom (std::string &tmp)
| This function is used to convert an atom name in char into an integer. Note that the integer corresponds to the atomic number of the atom minus one to fit easily with the C indexes.
int | conversionParam (std::string &param)
| This function is used to convert a type of parameter from string to int so it may be used in a switch case.
void | readParam (const char *parameterFileName, param_t *params)
| Read the file param.nci.
ProgData * | readxyzMinMax (param_t *params)
| Reads files (.xyz) and find the Min (MinX,MinY,MinZ) and the Max (MinX,MinY,MinZ)
bool | isWFmodeActivated ()
| Tool function which indicates if the current calculus is based on wfn/wfx/rkf files.
bool | isWFXmodeActivated ()
| Tool function which indicates if the current calculus is based on wfx file.
bool | isWFNmodeActivated ()
| Tool function which indicates if the current calculus is based on wfn file.
bool | isRKFmodeActivated ()
| Tool function which indicates if the current calculus is based on rkf file.
std::string | getMoleculeAatomDefinition ()
| Tool function which returns a string description of the FRAG1 atoms (given in param.igm)
std::string | getMoleculeBatomDefinition ()
| Tool function which returns a string description of the FRAG2 atoms (given in param.igm)
unsigned int | wfn_getMoleculeAnbAtoms ()
| Tool function which indicates the number of atoms in molecule A.
unsigned int | wfn_getMoleculeBnbAtoms ()
| Tool function which indicates the number of atoms in molecule B.
bool | isInMoleculeA (unsigned int atomNaturalIndex)
| Function which indicated if the given atom (natural index coming from WFN file) belongs to molecule A.
bool | isInMoleculeB (unsigned int atomNaturalIndex)
| Function which indicated if the given atom (natural index coming from WFN file) belongs to molecule B.
std::string | getCondensedDescriptionOfMoleculeA ()
| Function which returns the description of atoms included in molecule A.
std::string | getCondensedDescriptionOfMoleculeB ()
| Function which returns the description of atoms included in molecule B.
void | howUsingIGMplot ()
| Tool function which prints how the application can be launched.
bool | isIBSImodeActivated ()
| Tool function which indicates if the current calculus uses IBSI mode.
bool | isELFmodeActivated ()
| Tool function which indicates if ELF analysis is to be performed.
bool | isfullAOAccActivated ()
| Indicates if full accuracy is used for AO calculations.
bool | isHirshmodeActivated ()
| Tool function which indicates if the current calculus uses Hirsh mode.
bool | isCriticmodeActivated ()
| Tool function which indicates if the current calculus uses Critic mode.
bool | isParseRKF ()
| Tool function which indicates if RKF has to be parsed without grid calculation.
bool | isPauli ()
| Tool function which indicates if The Pauli exchange has to be estimated.
bool | isPauliAtomic ()
| Tool function which indicates if The Pauli exchange has to be estimated with atomic contrib.
bool | isdgSCALED ()
| Tool function which indicates if the dgSCALED mode is enabled.
bool | isCriticMEDIUMmodeActivated ()
| Tool function which indicates if the current calculus uses CriticMEDIUM mode.
bool | isCriticFINEmodeActivated ()
| Tool function which indicates if the current calculus uses CriticFINE mode.
bool | isCriticULTRAFINEmodeActivated ()
| Tool function which indicates if the current calculus uses CriticULTRAFINE mode.
bool | isCriticAddSeedsmodeActivated ()
| Tool function which indicates if additional seeds are use for cp search.
bool | isPeakFocusIntraActivated ()
| Tool function which indicates if a peakFocusIntra has been required by user.
bool | isPeakFocusInterActivated ()
| Tool function which indicates if a peakFocusInter has been required by user.
bool | atomBondsHaveBeenRegistered ()
| Tool function which indicates if atom bonds have been registered.
std::vector< std::pair< unsigned int, unsigned int > > & | getChosenBonds ()
| Function to gain access to the chosen bonds.
void | checkKeywords (param_t *params)
| Function to check the keywords compatibility.

## Variables
const std::string | ATOM_NAMES []
| The atoms' names.
const unsigned int | ATOM_COREORB []
| Number of CORE ORBITALS for each atom ! will serve to compute the BDA for valence MOs.
const unsigned int | ATOM_ELECTRONS []
| Total number of electrons for each atom.

## Detailed Description

Tool functions for reading input data.

Author
  Gaetan & Emmanuel

## Function Documentation

## ◆ atomBondsHaveBeenRegistered()

bool atomBondsHaveBeenRegistered | ( |  | ) |

Tool function which indicates if atom bonds have been registered.

Returns
  True if one or more bonds have been registered

Here is the caller graph for this function:

## ◆ checkKeywords()

void checkKeywords | ( | param_t * | params | ) |

Function to check the keywords compatibility.

Parameters

  params | The object gathering data read from param.igm

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ conversionAtom()

int conversionAtom | ( | std::string & | tmp | ) |

This function is used to convert an atom name in char into an integer. Note that the integer corresponds to the atomic number of the atom minus one to fit easily with the C indexes.

Parameters

  tmp | : the atomic symbole in char*.

Here is the caller graph for this function:

## ◆ conversionParam()

int conversionParam | ( | std::string & | param | ) |

This function is used to convert a type of parameter from string to int so it may be used in a switch case.

Parameters

  param | : the parameter as a string.

Returns
  the parameter as an integer.

Here is the caller graph for this function:

## ◆ getChosenBonds()

std::vector< std::pair< unsigned int, unsigned int > > & getChosenBonds | ( |  | ) |

Function to gain access to the chosen bonds.

Returns
  The wanted registered bonds

Here is the caller graph for this function:

## ◆ getCondensedDescriptionOfMoleculeA()

std::string getCondensedDescriptionOfMoleculeA | ( |  | ) |

Function which returns the description of atoms included in molecule A.

Returns
  The wanted description (compute at each call)

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ getCondensedDescriptionOfMoleculeB()

std::string getCondensedDescriptionOfMoleculeB | ( |  | ) |

Function which returns the description of atoms included in molecule B.

Returns
  The wanted description (compute at each call)

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ getMoleculeAatomDefinition()

std::string getMoleculeAatomDefinition | ( |  | ) |

Tool function which returns a string description of the FRAG1 atoms (given in param.igm)

Returns
  The string description

Here is the caller graph for this function:

## ◆ getMoleculeBatomDefinition()

std::string getMoleculeBatomDefinition | ( |  | ) |

Tool function which returns a string description of the FRAG2 atoms (given in param.igm)

Returns
  The string description

Here is the caller graph for this function:

## ◆ isANumber()

bool isANumber | ( | const std::string & | s | ) |

This function is used to check whether a string is a number or not.

Parameters

  s | : the string to check.

Returns
  true if the string was a number, false otherwise.

## ◆ isCriticAddSeedsmodeActivated()

bool isCriticAddSeedsmodeActivated | ( |  | ) |

Tool function which indicates if additional seeds are use for cp search.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isCriticFINEmodeActivated()

bool isCriticFINEmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses CriticFINE mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isCriticMEDIUMmodeActivated()

bool isCriticMEDIUMmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses CriticMEDIUM mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isCriticmodeActivated()

bool isCriticmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses Critic mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isCriticULTRAFINEmodeActivated()

bool isCriticULTRAFINEmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses CriticULTRAFINE mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isdgSCALED()

bool isdgSCALED | ( |  | ) |

Tool function which indicates if the dgSCALED mode is enabled.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isELFmodeActivated()

bool isELFmodeActivated | ( |  | ) |

Tool function which indicates if ELF analysis is to be performed.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isfullAOAccActivated()

bool isfullAOAccActivated | ( |  | ) |

Indicates if full accuracy is used for AO calculations.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isHirshmodeActivated()

bool isHirshmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses Hirsh mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isIBSImodeActivated()

bool isIBSImodeActivated | ( |  | ) |

Tool function which indicates if the current calculus uses IBSI mode.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isInMoleculeA()

bool isInMoleculeA | ( | unsigned int | atomNaturalIndex | ) |

Function which indicated if the given atom (natural index coming from WFN file) belongs to molecule A.

Parameters

  atomNaturalIndex | The atom index

Returns
  true if the atom is in molecule A

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ isInMoleculeB()

bool isInMoleculeB | ( | unsigned int | atomNaturalIndex | ) |

Function which indicated if the given atom (natural index coming from WFN file) belongs to molecule B.

Parameters

  atomNaturalIndex | The atom index

Returns
  true if the atom is in molecule B

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ isParseRKF()

bool isParseRKF | ( |  | ) |

Tool function which indicates if RKF has to be parsed without grid calculation.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isPauli()

bool isPauli | ( |  | ) |

Tool function which indicates if The Pauli exchange has to be estimated.

Returns
  True if Pauli exchange has to be estimated

Here is the caller graph for this function:

## ◆ isPauliAtomic()

bool isPauliAtomic | ( |  | ) |

Tool function which indicates if The Pauli exchange has to be estimated with atomic contrib.

Returns
  True if Pauli exchange has to be estimated

Here is the caller graph for this function:

## ◆ isPeakFocusInterActivated()

bool isPeakFocusInterActivated | ( |  | ) |

Tool function which indicates if a peakFocusInter has been required by user.

Returns
  True if PEAKFOCUSINTER keyword found in param.igm

Here is the caller graph for this function:

## ◆ isPeakFocusIntraActivated()

bool isPeakFocusIntraActivated | ( |  | ) |

Tool function which indicates if a peakFocusIntra has been required by user.

Returns
  True if PEAKFOCUSINTRA keyword found in param.igm

Here is the caller graph for this function:

## ◆ isRKFmodeActivated()

bool isRKFmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus is based on rkf file.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isWFmodeActivated()

bool isWFmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus is based on wfn/wfx/rkf files.

Returns
  The value of the corresponding flag

Here is the caller graph for this function:

## ◆ isWFNmodeActivated()

bool isWFNmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus is based on wfn file.

Returns
  The value of the corresponding flag

## ◆ isWFXmodeActivated()

bool isWFXmodeActivated | ( |  | ) |

Tool function which indicates if the current calculus is based on wfx file.

Returns
  The value of the corresponding flag

## ◆ readParam()

void readParam | ( | const char * | parameterFileName,
|  | param_t * | params )

Read the file param.nci.

Parameters

  parameterFileName | The parameter file name
  params | the parameters.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ readxyzMinMax()

ProgData * readxyzMinMax | ( | param_t * | params | ) |

Reads files (.xyz) and find the Min (MinX,MinY,MinZ) and the Max (MinX,MinY,MinZ)

Parameters

  params | : the read parameters.

Returns
  the data to fill.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ setFrag()

void setFrag | ( | const std::string | definition,
|  | const param_types_t | FRAG,
|  | const int | nbAtoms )

This function is used to ascribe FRAG atom indexes from string definition given in param.igm input file.

Parameters

  definition | : The string defining the fragment (for instance: 1-3; 8; 10-13)
  FRAG | : The selected fragment (FRAG1 or FRAG2) to be associated with string definition
  nbAtoms | : The total number of atoms in the molecular system

Here is the call graph for this function:

## ◆ wfn_getMoleculeAnbAtoms()

unsigned int wfn_getMoleculeAnbAtoms | ( |  | ) |

Tool function which indicates the number of atoms in molecule A.

Returns
  The size of the molecule A

Here is the caller graph for this function:

## ◆ wfn_getMoleculeBnbAtoms()

unsigned int wfn_getMoleculeBnbAtoms | ( |  | ) |

Tool function which indicates the number of atoms in molecule B.

Returns
  The size of the molecule B

Here is the caller graph for this function: