API documentation

pyGDM2 - a full-field electrodynamical solver python module, based on the Green dyadic method.

Contents:

• Simulation description
  • structures
    • structure definition class struct
    • Structure generators
    • Mesher
    • Other functions
  • materials
    • fromFile class
    • Predefined materials
  • fields
    • Incident electro-magnetic field class efield
    • field generators
• Core
  • core
    • simulation description class
    • electric fields inside particle
    • decay rate of dipole transition
    • Other functions
• Processing
  • linear
    • extinction/absorption/scattering cross-sections
    • nearfield around structure
    • farfield patterns
    • heat deposition inside structure
    • temperature rise close to structure
    • dipole decay rate evaluation
  • nonlinear
    • TPL and SP-LDOS
• Visualization, tools
  • visu
    • structure geometry
    • vector fields
    • scalar fields
    • animation
  • visu3d
    • structure geometry
    • vector fields
    • scalar fields
    • animation
  • tools
    • Save / Load / Print info
    • Field-index searching
    • Structure geometry tools
    • Spectra tools
    • Raster-scan tools
    • Coordinate-list transformations
    • 2D-mapping coordinate generators
    • Other
• Evolutionary Optimization
  • EO.core
    • run_eo: Launch an optimization
    • continue_eo: continue a former optimization
  • EO.models
    • BaseModel: Base class for model definitions
    • Predefined models
  • EO.problems
    • BaseProblem: Base class for problem definitions
    • Predefined problems
  • EO.tools
    • Get results from stored optimization
    • Results from Pareto multi-objective optimization
    • Other tools related to the Evolutionary Optimization module