Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | Properties | List of all members
CDPL.MolProp.MHMOPiChargeCalculator Class Reference

Calculator that uses a Modified Hückel Molecular Orbital (MHMO) treatment to compute pi-electron densities, pi-charges, pi-bond orders and the total pi-electron energy of a molecular graph. More...

+ Inheritance diagram for CDPL.MolProp.MHMOPiChargeCalculator:

Public Member Functions

None __init__ ()
 Constructs the MHMOPiChargeCalculator instance.
 
None __init__ (Chem.MolecularGraph molgraph)
 Constructs the MHMOPiChargeCalculator instance and performs the MHMO calculation for molgraph. More...
 
None __init__ (Chem.ElectronSystemList pi_sys_list, Chem.MolecularGraph molgraph)
 Constructs the MHMOPiChargeCalculator instance and performs the MHMO calculation for the given pi-electron systems of molgraph. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None localizedPiBonds (bool localized)
 Specifies whether the calculation shall use localized pi-bonds. More...
 
bool localizedPiBonds ()
 Specifies whether the calculation shall use localized pi-bonds. More...
 
None calculate (Chem.MolecularGraph molgraph)
 Performs the MHMO calculation for molgraph, perceiving the pi-electron systems on the fly. More...
 
None calculate (Chem.ElectronSystemList pi_sys_list, Chem.MolecularGraph molgraph)
 Performs the MHMO calculation for the given pi-electron systems of molgraph. More...
 
float getElectronDensity (int atom_idx)
 Returns the calculated pi-electron density of the atom at index atom_idx. More...
 
float getCharge (int atom_idx)
 Returns the calculated pi-charge of the atom at index atom_idx. More...
 
float getBondOrder (int bond_idx)
 Returns the calculated pi-bond order of the bond at index bond_idx. More...
 
float getEnergy ()
 Returns the total pi-electron energy of the molecular graph from the last calculation. More...
 

Properties

 objectID = property(getObjectID)
 
 locPiBonds = property(localizedPiBonds, localizedPiBonds)
 
 energy = property(getEnergy)
 

Detailed Description

Calculator that uses a Modified Hückel Molecular Orbital (MHMO) treatment to compute pi-electron densities, pi-charges, pi-bond orders and the total pi-electron energy of a molecular graph.

The calculator can either perceive the pi-electron systems of the molecular graph itself (via Chem.ElectronSystemList) or accept a pre-computed list of pi-systems. The MHMO parameter set follows the parameterization described in the PhD thesis of Thomas Kleinöder (Computer Chemistry Center, Univ. Erlangen-Nuremberg, 2005).

See also
[MHMO]

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.MolProp.MHMOPiChargeCalculator.__init__ ( Chem.MolecularGraph  molgraph)

Constructs the MHMOPiChargeCalculator instance and performs the MHMO calculation for molgraph.

The pi-electron systems are perceived from molgraph.

Parameters
molgraphThe molecular graph for which to perform the MHMO calculation.

◆ __init__() [2/2]

None CDPL.MolProp.MHMOPiChargeCalculator.__init__ ( Chem.ElectronSystemList  pi_sys_list,
Chem.MolecularGraph  molgraph 
)

Constructs the MHMOPiChargeCalculator instance and performs the MHMO calculation for the given pi-electron systems of molgraph.

Parameters
pi_sys_listThe list of pi-electron systems.
molgraphThe molecular graph.

Member Function Documentation

◆ getObjectID()

int CDPL.MolProp.MHMOPiChargeCalculator.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python MHMOPiChargeCalculator instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two MHMOPiChargeCalculator instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ localizedPiBonds() [1/2]

None CDPL.MolProp.MHMOPiChargeCalculator.localizedPiBonds ( bool  localized)

Specifies whether the calculation shall use localized pi-bonds.

Parameters
localizedIf True, conjugated pi-systems are treated as a set of localized pi-bonds.

◆ localizedPiBonds() [2/2]

bool CDPL.MolProp.MHMOPiChargeCalculator.localizedPiBonds ( )

Specifies whether the calculation shall use localized pi-bonds.

Parameters
localizedIf True, conjugated pi-systems are treated as a set of localized pi-bonds.

◆ calculate() [1/2]

None CDPL.MolProp.MHMOPiChargeCalculator.calculate ( Chem.MolecularGraph  molgraph)

Performs the MHMO calculation for molgraph, perceiving the pi-electron systems on the fly.

Parameters
molgraphThe molecular graph for which to perform the MHMO calculation.

◆ calculate() [2/2]

None CDPL.MolProp.MHMOPiChargeCalculator.calculate ( Chem.ElectronSystemList  pi_sys_list,
Chem.MolecularGraph  molgraph 
)

Performs the MHMO calculation for the given pi-electron systems of molgraph.

Parameters
pi_sys_listThe list of pi-electron systems.
molgraphThe molecular graph.

◆ getElectronDensity()

float CDPL.MolProp.MHMOPiChargeCalculator.getElectronDensity ( int  atom_idx)

Returns the calculated pi-electron density of the atom at index atom_idx.

Parameters
atom_idxThe zero-based atom index.
Returns
The calculated pi-electron density.
Exceptions
Base.IndexErrorif atom_idx is out of bounds.

◆ getCharge()

float CDPL.MolProp.MHMOPiChargeCalculator.getCharge ( int  atom_idx)

Returns the calculated pi-charge of the atom at index atom_idx.

Parameters
atom_idxThe zero-based atom index.
Returns
The calculated pi-charge.
Exceptions
Base.IndexErrorif atom_idx is out of bounds.

◆ getBondOrder()

float CDPL.MolProp.MHMOPiChargeCalculator.getBondOrder ( int  bond_idx)

Returns the calculated pi-bond order of the bond at index bond_idx.

Parameters
bond_idxThe zero-based bond index.
Returns
The calculated pi-bond order.
Exceptions
Base.IndexErrorif bond_idx is out of bounds.

◆ getEnergy()

float CDPL.MolProp.MHMOPiChargeCalculator.getEnergy ( )

Returns the total pi-electron energy of the molecular graph from the last calculation.

Returns
The total pi-electron energy.