Skip to content
Sections
Personal tools
You are here: Home » BALLView » Documentation » 1.2 » structBALL_1_1PierottiCavFreeEnergyProcessor_1_1Option_html

BALL::PierottiCavFreeEnergyProcessor::Option Struct Reference

Symbolic names for option keys. More...

#include <pierottiCavFreeEnergyProcessor.h>

List of all members.


Static Public Attributes

const char * VERBOSITY
The verbosity level.
const char * SOLVENT_NUMBER_DENSITY
The number density of the solvent.
const char * PRESSURE
The pressure.
const char * ABSOLUTE_TEMPERATURE
The temperature.
const char * PROBE_RADIUS
The probe radius.

Detailed Description

Symbolic names for option keys.

This struct contains a symbolic name for each recognized key in PierottiCavFreeEnergyProcessor::options.


Member Data Documentation

const char* BALL::PierottiCavFreeEnergyProcessor::Option::ABSOLUTE_TEMPERATURE [static]

The temperature.

This option defines the absolute temperature at which the solvation takes place. Use float values of unit K with this option.

See also:
Default::ABSOLUTE_TEMPERATURE
Parameters:
absolute_temperature float;
const char* BALL::PierottiCavFreeEnergyProcessor::Option::PRESSURE [static]

The pressure.

With this option it is possible to define the pressure under which the solvation takes place. Use float values of unit Pa with this option.

See also:
Default::PRESSURE
Parameters:
pressure float
const char* BALL::PierottiCavFreeEnergyProcessor::Option::PROBE_RADIUS [static]

The probe radius.

This option defines the hard sphere solvent radius needed for the calculation of the cavitation free energy according to the scaled particle theory. Use float values of unit $ A $ with this option.

See also:
Default::PROBE_RADIUS
Parameters:
probe_radius float;
const char* BALL::PierottiCavFreeEnergyProcessor::Option::SOLVENT_NUMBER_DENSITY [static]

The number density of the solvent.

This option defines the number density of the surrounding solvent. Use float values of unit $ A^{-3} $ with this option.

See also:
Default::SOLVENT_NUMBER_DENSITY
Parameters:
solvent_number_density float
const char* BALL::PierottiCavFreeEnergyProcessor::Option::VERBOSITY [static]

The verbosity level.

Use integer values with this option.

See also:
Default::VERBOSITY
Parameters:
verbosity integer

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

Powered by Plone

This site conforms to the following standards: