:html_theme.sidebar_secondary.remove:

tidy3d.ModeSimulation
=====================

.. autoclass:: tidy3d.ModeSimulation
   :members:
   :show-inheritance:
   :undoc-members:
   :member-order: bysource
   :exclude-members: attrs, model_config, model_post_init, type

   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   .. rubric:: Attributes

   .. autosummary::
      
        ~ModeSimulation.grid
        ~ModeSimulation.reduced_simulation_copy
        ~ModeSimulation.mode_spec
        ~ModeSimulation.freqs
        ~ModeSimulation.direction
        ~ModeSimulation.colocate
        ~ModeSimulation.use_colocated_integration
        ~ModeSimulation.conjugated_dot_product
        ~ModeSimulation.fields
        ~ModeSimulation.boundary_spec
        ~ModeSimulation.monitors
        ~ModeSimulation.sources
        ~ModeSimulation.internal_absorbers
        ~ModeSimulation.grid_spec
        ~ModeSimulation.plane
        ~ModeSimulation.lumped_elements
        ~ModeSimulation.subpixel
        ~ModeSimulation.simulation_type
        ~ModeSimulation.post_norm
        ~ModeSimulation.medium
        ~ModeSimulation.structures
        ~ModeSimulation.symmetry
        ~ModeSimulation.version
        ~ModeSimulation.plot_length_units
        ~ModeSimulation.structure_priority_mode
        ~ModeSimulation.size
        ~ModeSimulation.center
   
   
   

   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   .. rubric:: Methods

   .. autosummary::
       
            ~ModeSimulation.from_mode_solver
            ~ModeSimulation.from_simulation
            ~ModeSimulation.plot
            ~ModeSimulation.plot_eps_mode_plane
            ~ModeSimulation.plot_grid_mode_plane
            ~ModeSimulation.plot_mode_plane
            ~ModeSimulation.plot_pml_mode_plane
            ~ModeSimulation.plot_structures_eps_mode_plane
            ~ModeSimulation.run_local
            ~ModeSimulation.validate_pre_upload