API documentation

pyGDM2 - a full-field electrodynamical solver python toolkit. Based on the Green Dyadic Method.

Contributors:

• P.R. Wiecha (maintainer)

• Ch. Girard

• 1. Arbouet

• 3. Majorel

• 1. Patoux

• 7. Colas des Francs

• 25. Brûlé

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
    • vector beams
    • deprecated generators
  • Environment - set of Green’s Dyads
    • DyadsBaseClass()
    • 3D - 1-2-3 layer non-retarded surface dyads
    • 2D - 1-2-3 layer non-retarded surface dyads
    • 3D - periodic dyads (homogeneous environment)
• Core
  • core
    • simulation description class
    • simulate electromagnetic fields inside particles
    • decay rate of dipole transitions / LDOS
    • Other functions
• Processing
  • linear
    • near-field
    • far-field
  • multipole decomposition
    • multipole_decomposition_exact()
    • extinct()
    • scs()
    • generalized_polarizability()
    • extract_effective_polarizability()
  • nonlinear
    • TPL and SP-LDOS
  • fast electrons
    • electron beam incident field
    • EELS and cathodoluminescence (CL)
    • tools
• Visualization, tools
  • visu
    • structure()
    • structure_contour()
    • vector fields
    • scalar fields
  • visu3d
    • structure()
    • vector fields
    • scalar fields
  • 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