ResultGetBondingFraction

Top  Previous  Next

Return the bonding fraction for a site calculated by the association term. Units: [-]

 

Note: Bonding fraction is defined as the fraction of sites not bonded.

 

This function is defined in C++ as:

extern "C" __declspec(dllexport) double __stdcall ResultGetBondingFraction(int PointIndex, int PhaseIndex, int ComponentIndex, int BlockIndex, int SiteIndex)

 

Return

The bonding fraction for a site calculated by the association term. Units: [-]

 

Input

Argument

Type

Description

PointIndex

int

Point to retrieve the value from

PhaseIndex

int

Phase to retrieve the value from

ComponentIndex

int

Component to retrieve the value from

BlockIndex

int

Block to retrieve the value from

SiteIndex

int

Site to retrieve the value from

 

Note

If a error/problem is found use the function ErrorGetIndex and ErrorGetMessage to get more information

 

Code examples