OEEonPBOptions

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEEonPBOptions : public OESystem::OEOptions

This class sets up options required for generating PB calculations with OEEonPBFunc.

The OEEonPBOptions class defines the following public methods:

Constructors

OEEonPBOptions()
OEEonPBOptions(const OEEonPBOptions &)

Default and copy constructors.

operator=

OEEonPBOptions &operator=(const OEEonPBOptions &)

Assignment operator.

GetDielectric

double GetDielectric() const

Returns dielectric constant used in PB computation. See SetDielectric method.

SetDielectric

bool SetDielectric(const double)

Sets the dielectric constant in PB computation. Default: 80.0.

GetSaltConcentration

double GetSaltConcentration() const

Returns salt concentration value in PB computation. See SetSaltConcentration method.

SetSaltConcentration

bool SetSaltConcentration(const double)

Sets salt concentration value in PB computation. Default: 0.04.

GetInnerMask

double GetInnerMask() const

Returns inner mask in PB computation. See SetInnerMask method.

SetInnerMask

bool SetInnerMask(const double)

Sets the inner mask in PB computation. Default: 0.05.

GetOuterMask

double GetOuterMask() const

Returns the outer mask value in PB computation. See SetOuterMask method.

SetOuterMask

bool SetDielectric(const double)

Sets the outer mask in in PB computation. Default: 0.0005.

GetGridSpacing

double GetGridSpacing() const

Returns grid spacing used internally in PB computation. See SetGridSpacing method.

SetGridSpacing

bool SetGridSpacing(const double)

Sets the grid spacing for PB computation. Default: 0.75.

GetGridBuffer

double GetGridBuffer() const

Grid buffer value used in PB computation. See SetGridBuffer method.

SetGridBuffer

bool SetGridBuffer(const double)

Sets the grid buffer value used in PB computation. Default: 6.0.