Species

class openfts.Species(label=None, stat_segment_length=None, b=None, smearing_length=None, a=None, smearing_length_units=None, a_units=None, charge=None)

TODO add short description of Species object

Parameters:

• label (string) – String used to label this species throughout the code. This allows more human-readable output and error messages

• stat_segment_length (float) – Statistical segment length of species (in units of bref). Default: 1.

• b (float) – Statistical segment length of species (in units of bref). Default: 1.

• smearing_length (float) – Density smearing length. Default: 0.

• a (float) – Density smearing length. Default: 0.

• smearing_length_units (string) – Smearing length units. Either Rg or b. Default: Rg.

• a_units (string) – Smearing length units. Either Rg or b. Default: Rg.

• charge (float) – Charge of species per statistical segment length. Default: 0. (CONFIRM)

Example (python)

import openfts
fts = openfts.OpenFTS()
...
fts.species.append(openfts.Species(label='A',stat_segment_length=1.0))
fts.species.append(openfts.Species(label='B',stat_segment_length=1.0))
...

Example (json)

"species": {
  "nspecies": 2,
  "species0": {
    "label": "A",
    "stat_segment_length": 1.0
  },
  "species1": {
    "label": "B",
    "stat_segment_length": 1.0
  }
}